Skip to content

docs: add Theme Elementary guides and Docusaurus workflow - #778

Closed
Adi-ty wants to merge 7 commits into
feat/init-devtoolsfrom
docs/theme-elementary-v2
Closed

Adi-ty wants to merge 7 commits into
feat/init-devtoolsfrom
docs/theme-elementary-v2

Conversation

@Adi-ty

@Adi-ty Adi-ty commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Description

Create a clear documentation journey for Theme Elementary and publish it through the shared Docusaurus workflow.

Technical Details

  • Reworked README.md, DEVELOPMENT.md, and CONTRIBUTING.md as concise entry points.
  • Added Getting Started, Initialization, Local Development, Features, and Scaffolding guides.
  • Replaced the old Quick Start and internal-testing documentation with structured internal maintainer guidance.
  • Added cleanup validation, dependency-development procedures, temporary-procedure tracking, and validation-result recording.
  • Added Graphify maintainer guidance.
  • Updated asset, HMR, and Tailwind documentation links and behavior.
  • Added the shared Docusaurus documentation workflow, pinned to a reviewed revision.
  • Configured the supported theme-elementary-v2 branch and documentation sidebar.

Checklist

  • Provide a primary Getting Started path.
  • Document acquisition, initialization, local development, checks, and production builds.
  • Catalogue built-in, example, and optional functionality.
  • Document manual extension and companion-plugin CPT/taxonomy examples.
  • Keep maintainer-only procedures under docs/internal/.
  • Add documentation build automation.
  • Remove stale Quick Start and internal-testing references.
  • Verify documentation links and anchors.

Fixes/Covers Issue

Fixes #768

Covers #769, #770, #771, #772, #773, #774, #775, #776

Consolidate onboarding, development, feature, and maintainer guidance, and build the documentation site through the shared workflow.
@Adi-ty
Adi-ty added this pull request to stack #779 September 15, 2026 08:52
@Adi-ty
Adi-ty marked this pull request as ready for review September 15, 2026 08:57

@divyarajmasani divyarajmasani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Adi-ty

I reviewed the PR, I believe the documentation could you more user friendly language. We need not make every paragraph as short as possible.

Also, there were some good documentation overridden by a short version as well, let's revisit these changes again and ensure we do not introduce changes where it doesn't require.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread bin/scaffold.config.js Resolved
Comment thread .github/workflows/documentation.yml Resolved
Comment thread docs/getting-started.md Resolved
Comment thread docs/getting-started.md Resolved
Comment thread docs/getting-started.md Resolved
Comment thread docs/getting-started.md Resolved
Comment thread docs/hmr.md Resolved

@divyarajmasani divyarajmasani left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now, just a few minor recommendations. And we can merge this.

Comment thread .claude/skills/README.md Resolved
Comment thread docs/internal/maintenance.md Resolved
Comment thread docs/asset-building-process.md Resolved
Comment thread docs/hmr.md Resolved
Comment thread docs/initialization.md Resolved
Comment thread README.md Resolved
- Restore Directory Structure section in asset-building-process.md, replacing the Source to output table
- Revert BrowserSync constant to ELEMENTARY_THEME_BROWSER_SYNC_URL in hmr.md
- Point Copilot prompts URL to theme-elementary-v2 where prompts exist (absolute because relative breaks after init removes .github/prompts)
- Re-add folder structure section to README.md
@aryanjasala aryanjasala mentioned this pull request Oct 1, 2026
@Adi-ty

Adi-ty commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

Folded in #787

@Adi-ty Adi-ty closed this Nov 5, 2026
@Adi-ty
Adi-ty deleted the docs/theme-elementary-v2 branch November 5, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants