Summary
Organize documentation around the developer's journey: start a project, understand what the skeleton includes, modify an example, add functionality, and resolve common failures. Provide enough context to complete these tasks without requiring developers to read framework source.
Branch baseline
Use theme-elementary-v2 as the base branch for this epic and every sub-issue. Document the functionality introduced on that branch and subsequent changes built on it; do not use main as the implementation reference. Before writing or validating a guide, check the latest relevant v2 changes and record the branch and commit tested in the documentation PR.
Documentation ownership
- Theme Elementary: what ships, where files belong, initialization, local workflows, integration examples, and troubleshooting specific to the skeleton.
- wp-framework: detailed class contracts, inherited methods, lifecycle, APIs, and full framework tutorials.
- wp-tooling: generic scaffold catalogue, engine behavior, and exhaustive command options.
Link directly to relevant, version-compatible upstream documentation. Do not reproduce those references locally or require developers to search upstream homepages.
Documentation map and sub-issues
Shared editorial requirements
- Give each page one task and a clear outcome; put advanced material behind links.
- Keep one canonical home for each procedure. Getting Started composes the minimum steps; reference pages provide detail.
- Each example answers: where does it go, what changes, how does it become active, and how is success checked?
- State the working directory and distinguish standalone setup from an existing WordPress/VIP repository. Link to project-level instructions for full VIP setup.
- Explain AI and CLI as alternative entry points; make their differing outputs and remaining work explicit.
- Use brief symptom → check → next action troubleshooting entries.
- Include review checkpoints after personalization and feature completion. Suggest separate baseline and feature commits without imposing a history policy.
- Verify commands against
theme-elementary-v2 and subsequent work based on it; test the user journeys in a disposable project and record the tested commit.
- Keep links valid when documents move or downstream cleanup removes files; update old entry points.
- Keep pilot workarounds separate and time-bound. Do not publish hypothetical stable commands as working instructions.
Acceptance criteria
Implementation dependencies and exclusions
Cleanup failures, dependency-install behavior, scaffold wrappers, test-script fixes, and CI automation belong in separate implementation issues. Link concrete dependencies where they prevent a documented journey from working; do not silently expand documentation tasks into code changes.
This epic does not prescribe dynamic versus static blocks, redesign framework APIs, or duplicate framework/tooling manuals.
Summary
Organize documentation around the developer's journey: start a project, understand what the skeleton includes, modify an example, add functionality, and resolve common failures. Provide enough context to complete these tasks without requiring developers to read framework source.
Branch baseline
Use
theme-elementary-v2as the base branch for this epic and every sub-issue. Document the functionality introduced on that branch and subsequent changes built on it; do not usemainas the implementation reference. Before writing or validating a guide, check the latest relevant v2 changes and record the branch and commit tested in the documentation PR.Documentation ownership
Link directly to relevant, version-compatible upstream documentation. Do not reproduce those references locally or require developers to search upstream homepages.
Documentation map and sub-issues
README.mddocs/getting-started.mddocs/initialization.mddocs/local-development.mddocs/scaffolding.mddocs/features.mdDEVELOPMENT.mddocs/internal/Shared editorial requirements
theme-elementary-v2and subsequent work based on it; test the user journeys in a disposable project and record the tested commit.Acceptance criteria
Implementation dependencies and exclusions
Cleanup failures, dependency-install behavior, scaffold wrappers, test-script fixes, and CI automation belong in separate implementation issues. Link concrete dependencies where they prevent a documented journey from working; do not silently expand documentation tasks into code changes.
This epic does not prescribe dynamic versus static blocks, redesign framework APIs, or duplicate framework/tooling manuals.