Repository navigation
docs: organize usage guides under How to - #5230
Conversation
Move nine guides into a dedicated How to category, retain process quickstarts in Getting Started, and update site navigation and README links. Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only reorganization includes corresponding navigation, DocFX, cross-page, homepage, and translated README link updates, with no blocking concerns identified in review.
No open issues 🎉
What changed in this PR
This pull request reorganizes nine usage and conceptual guides under a new top-level How to documentation section. It updates navigation, DocFX inclusion, cross-page links, homepage links, and English and translated README references without changing runtime behavior.
Changes:
- Adds the
docs/how-to/directory, landing page, and task-oriented guide titles. - Moves guides from their previous sections while retaining quickstarts, installation, reference, and component-authoring content.
- Updates documentation navigation and links across the site and repository READMEs.
- A moderate follow-up remains for preserving redirects or equivalent handling for previously published guide URLs.
| File | Description |
|---|---|
README.zh-CN.md |
Updates translated links to relocated How to guides. |
README.md |
Updates guide links and adds the How to documentation entry. |
README.ko.md |
Updates Korean links to relocated guides. |
README.ja.md |
Updates Japanese links to relocated guides. |
docs/toc.yml |
Adds the How to section and removes relocated entries from previous sections. |
docs/reference/agentic-sdd.md |
Updates the SDD philosophy reference link. |
docs/README.md |
Documents the new How to source directory and pages. |
docs/quickstart.md |
Updates existing-project and customization links. |
docs/presets/overview.md |
Updates the customization guide link. |
docs/integrations/index.md |
Updates the project-local override reference. |
docs/installation.md |
Updates the existing-project guide link. |
docs/index.md |
Updates homepage links and adds a How to navigation card. |
docs/how-to/spec-persistence.md |
Retitles the guide and updates related links. |
docs/how-to/spec-of-specs.md |
Retitles the guide with a task-oriented title. |
docs/how-to/sdd.md |
Retitles the guide and updates related links. |
docs/how-to/monorepo.md |
Retitles the monorepo guide. |
docs/how-to/index.md |
Adds the How to directory page and guide links. |
docs/how-to/existing-projects.md |
Retitles the guide and updates related links. |
docs/how-to/evolving-specs.md |
Retitles the guide and updates related links. |
docs/how-to/customization.md |
Retitles the guide and updates quickstart links. |
docs/how-to/contract-driven-development.md |
Retitles the contract-driven development guide. |
docs/how-to/complex-features.md |
Retitles the complex-features guide. |
docs/guides/bugfix.md |
Updates the existing-project guide link. |
docs/guides/assessment.md |
Updates the existing-project guide link. |
docs/guides/agentic-sdlc.md |
Updates the customization guide link. |
docs/extensions/overview.md |
Updates the specification persistence reference. |
docs/docfx.json |
Removes the old concepts glob and includes the How to directory. |
docs/community/overview.md |
Updates the customization guide reference. |
Review effort: Lite (auto)
Preserve the How to guide relocation alongside upstream workflow and bundle documentation changes. Update the new bundle overview's customization link to its canonical How to page. Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Merged the latest upstream |
Description
Organize nine existing usage and conceptual guides under a top-level How to
category, with task-oriented page titles, a guide directory, and consistent
navigation. Keep the SDD, bug-fixing, and idea-assessment quickstarts in Getting
Started, and leave installation, upgrades, component authoring, and reference
documentation in their existing sections.
Update DocFX content inclusion, homepage links, cross-page links, and repository
README links, including the translated READMEs. Preserve the moved guides'
instructions and examples without adding functionality.
Testing
uv run specify --helpuv sync && uv run pytestcd docs && docfx docfx.json— passed with 0 errors and 3 warnings concerningunchanged parent-directory glob patterns and an existing reference link.
git diff --check— passed.The CLI, pytest suite, and sample-project checks above were not run because
this change only reorganizes documentation.
AI Disclosure
AI disclosure: GitHub Copilot using GPT-6.1 Sol (model ID: gpt-6.1-sol),
agent/autonomous execution following a user-approved scope and navigation plan.
AI assistance covered documentation inventory, page moves and titles,
navigation and link updates, validation, and this PR description. No runtime
code or command behavior was changed.