Skip to content

docs: organize usage guides under How to - #5230

Merged
mnriem merged 2 commits into
github:mainfrom
mnriem:mnriem-docs-how-to
Nov 3, 2026
Merged

mnriem merged 2 commits into
github:mainfrom
mnriem:mnriem-docs-how-to

Conversation

@mnriem

@mnriem mnriem commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator

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

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

cd docs && docfx docfx.json — passed with 0 errors and 3 warnings concerning
unchanged 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

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

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.

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>
Copilot AI auto review requested due to automatic review settings November 3, 2026 22:08

Copilot AI 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.

🟢 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>
Copilot AI auto review requested due to automatic review settings November 3, 2026 22:14
@mnriem

mnriem commented Nov 3, 2026

Copy link
Copy Markdown
Collaborator Author

Merged the latest upstream main and resolved the README and DocFX conflicts in 2e3b1ade, preserving the workflow and bundle documentation updates alongside the How to section. Also updated the new bundle overview's customization link to the relocated page. Legacy-URL redirects remain deferred to keep this change within the agreed canonical-page migration scope, without forwarding stubs. Posted on behalf of @mnriem by GitHub Copilot using GPT-6.1 Sol (gpt-6.1-sol), agent/autonomous mode; AI assistance covered conflict resolution, link updates, and this summary.

Copilot AI 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.

🟢 Approval recommended

The documentation-only reorganization preserves guide content while updating navigation and internal and translated links, leaving no active review issues.

No open issues 🎉

Review effort: Lite (auto)

@mnriem
mnriem merged commit a227e38 into github:main Nov 3, 2026
22 checks passed
@mnriem
mnriem deleted the mnriem-docs-how-to branch November 3, 2026 22:32
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