docs: simplify README around three processes - #4591
Merged
Merged
Conversation
Use one shared setup and independent SDD, bug-fixing, and idea-assessment quickstarts. Consolidate detailed content into the docs and contributor guide, add missing process guides, align Chinese documentation, and preserve navigation without widening the site header. Assisted-by: GitHub Copilot (model: gpt-6-astra, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Explicitly describe workflow steps as skills invoked in the agent chat, while reserving terminal instructions for CLI installation and project or extension setup. Assisted-by: GitHub Copilot (model: gpt-6-astra, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
Three moderate documentation issues remain unresolved.
Review tier: Lite (auto)
Findings: None
Note
Copilot is running an experiment and ran this review at Lite.
What changed in this PR
This documentation-only PR simplifies onboarding around SDD, bug fixing, and idea assessment.
Changes:
- Streamlines English and Chinese READMEs.
- Adds process guides, references, customization guidance, and navigation updates.
- Moves historical, community, CI, and dogfooding details into dedicated documentation.
| File | Summary |
|---|---|
README.zh-CN.md |
Updated Chinese onboarding; one moderate anchor-compatibility issue (1 vote). |
README.md |
Simplified process-oriented onboarding; two moderate legacy-anchor issues (1 vote each). |
docs/toc.yml |
Reorganized documentation navigation. |
docs/reference/overview.md |
Documents independent processes. |
docs/reference/integrations.md |
Documents invocation formats. |
docs/reference/bundles.md |
Clarifies bundle examples and catalog policies. |
docs/reference/agentic-sdd.md |
Expands SDD command reference. |
docs/reference/agentic-bugfix.md |
Aligns bug-fix reference guidance. |
docs/reference/agentic-assessment.md |
Adds assessment command reference. |
docs/README.md |
Documents the new documentation structure. |
docs/quickstart.md |
Updates the SDD walkthrough and skills syntax. |
docs/local-development.md |
Links contributor dogfooding guidance. |
docs/installation.md |
Consolidates setup and process guidance. |
docs/index.md |
Reorganizes the documentation homepage. |
docs/history.md |
Moves historical and acknowledgement content. |
docs/guides/existing-projects.md |
Adds independent process guidance; one moderate invocation-syntax issue (1 vote). |
docs/guides/customization.md |
Adds customization guidance. |
docs/guides/bugfix.md |
Adds bug-fixing walkthrough. |
docs/guides/assessment.md |
Adds idea-assessment walkthrough. |
docs/community/overview.md |
Adds publishing and trust guidance. |
CONTRIBUTING.md |
Adds dogfooding documentation. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
5 tasks
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Make the README a practical starting point rather than a combined tutorial, reference, and project history. Reduce it from 492 to ~195 lines, with one shared installation/initialization and three independent entry points: Spec-Driven Development, bug fixing, and idea assessment. Process steps are described as skills invoked in the coding agent's chat, with the terminal reserved for CLI installation and project/extension setup.
bugandassess.Testing
Documentation-only change; no CLI implementation, templates, extension manifests, or catalogs changed.
../glob patterns indocs/docfx.json.The template's CLI checks are not applicable to this documentation-only change.
AI Disclosure
GitHub Copilot (models: gpt-6-astra and Claude Opus 4.8), acting on behalf of @mnriem, authored the documentation changes, coordinated translation and an independent review, ran the documentation/browser checks, and fixed the review findings. The human requested and directed the scope; agent execution was autonomous, not human line-by-line authorship. The commits include Assisted-by and Co-authored-by trailers.