Repository navigation
docs: streamline README onboarding and process guides - #5029
Conversation
Focus Get started on initial setup, preserve installation and upgrade details in their guides, and clarify each process example. Connect customization guidance to the capability inventory and replace the old video overview with Open Source Friday coverage. 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.
🟡 Changes recommended
The PyPI upgrade advice directs pipx/pip users to uv, which can create duplicate CLI installations.
1 open issue
What changed in this PR
Streamlines Spec Kit onboarding and moves detailed setup guidance into dedicated documentation.
Changes:
- Simplifies setup and process examples.
- Expands upgrade and customization guidance.
- Replaces the old video overview with news links and removes stale translated links.
AI disclosure: GitHub Copilot for the requester; model/settings unavailable; automated documentation review.
| File | Description |
|---|---|
| README.zh-CN.md | Removes stale video link. |
| README.md | Simplifies onboarding and adds news links. |
| README.ko.md | Removes stale video link and anchor. |
| README.ja.md | Removes stale video link. |
| docs/upgrade.md | Links PyPI-specific upgrade instructions. |
| docs/quickstart.md | Removes obsolete video section. |
| docs/installation.md | Adds agent-selection and invocation guidance. |
| docs/install/pypi.md | Adds installed-version and upgrade advice. |
| docs/guides/customization.md | Covers integrations and custom workflow-step packages. |
Review effort: Max
Scope repeated-install behavior to uv and direct uv, pipx, and pip users to upgrade through their original tool to avoid duplicate specify installations. Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Updated in 1d17b19: the PyPI guide now scopes uv repeated-install behavior to uv installations and directs users to upgrade with their original installer (uv, pipx, or pip). It also warns that switching installers can create duplicate installations and leave the old executable first on PATH. Checked the wording against the existing per-installer Upgrade section; AI disclosure: Posted for @mnriem by GitHub Copilot using GPT-6.1 Sol (gpt-6.1-sol), autonomous documentation editing and review-response generation; reasoning-effort setting not exposed. |

Description
Streamline the README so first-time setup stays focused and each process explains its own execution steps.
The intended Pages links are preserved. During review, the Catalog page and extension-runtime-events fragment were not yet deployed; the upstream documentation workflow was confirmed pending. Their source files and headings exist.
Testing
uv run specify --helpuv sync && uv run pytestDocumentation-only changes; the CLI smoke test, pytest suite, sample-project execution, and DocFX build were not run. No executable code, command templates, dependencies, or workflow configuration changed.
git --no-pager diff --check— passed.git diff --cached --check— passed before committing.Reproduce README source-link validation
AI Disclosure
AI disclosure: Authored by GitHub Copilot using GPT-6.1 Sol (model ID: gpt-6.1-sol), acting for @mnriem. The user directed the scope and iteratively reviewed wording; the agent performed the edits, documentation review, link checks, Git operations, and PR drafting. Agent-authored/autonomous work is disclosed without claiming complete human line-by-line review; the reasoning-effort setting was not exposed. Assistance covered documentation and an ad hoc validation command, not product-code generation.