Skip to content

docs: reframe SDD positioning, modernize install, and de-duplicate walkthroughs#30

Closed
mnriem wants to merge 1 commit into
mainfrom
mnriem-docs-rewrite-sdd-intro
Closed

docs: reframe SDD positioning, modernize install, and de-duplicate walkthroughs#30
mnriem wants to merge 1 commit into
mainfrom
mnriem-docs-rewrite-sdd-intro

Conversation

@mnriem

@mnriem mnriem commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Summary

Documentation-only pass that updates how Spec Kit positions itself, corrects stale setup claims, and removes duplicated walkthrough material.

Landing page (docs/index.md)

  • Reframe the intro so Spec Kit reads as a toolkit for Spec-Driven Development or your own process with any AI coding agent.
  • Switch install to PyPI (uv tool install specify-cli).
  • Correct stale claims — context files and git are now opt-in extensions, not auto-configured.
  • Generalize the "Make it your own" / organization cards to cover bundles and catalog hosting across all primitives.

Quick Start (docs/quickstart.md)

  • Restructure into a lean, guided Taskify walkthrough, one command per step.
  • Install is now a prerequisite; command Steps 1–9 align with the "Full path" list.
  • Deep per-command detail moved out to new reference pages (below).

New reference pages

  • docs/reference/agentic-sdd.md — full reference for the /speckit.* SDD process (constitution → converge), including arguments, output, phased implementation, and quality gates.
  • docs/reference/agentic-bugfix.md — reference for the bundled bug extension (assess / fix / test).
  • Retitle the reference overview from "CLI Reference" to "Reference" and group the agentic processes in their own section, distinct from CLI-managed primitives. Nav (toc.yml) updated to match.

README (README.md)

  • Remove the duplicated collapsed Detailed Process walkthrough (~283 lines) and its TOC entry — it duplicated the website Quick Start, the new Agentic SDD reference, and spec-driven.md.
  • Repoint the "Learn More" walkthrough link to the docs-site Quick Start.
  • Keep the concise Get Started section as the README's front door.

Also

  • Remove lingering "context rules" claims from reference/overview.md and reference/integrations.md.

All internal links verified to resolve. No code changes.


Assisted-by: GitHub Copilot (model: Claude Opus 4.8, supervised). Opened on behalf of @mnriem.

…lkthroughs

Reframe the landing page so Spec Kit reads as a toolkit for Spec-Driven
Development *or your own process* with any AI coding agent, and correct
stale claims: context files and git are now opt-in extensions, and the
install path uses PyPI (specify-cli). Generalize the landing cards to
cover bundles and catalog hosting across all primitives.

Restructure the Quick Start into a lean, guided Taskify walkthrough with
one command per step (install as a prerequisite, Steps 1-9 aligned with
the Full path), and extract the deep per-command detail into two new
reference pages: reference/agentic-sdd.md (the /speckit.* SDD process)
and reference/agentic-bugfix.md (the bug extension). Retitle the
reference overview to "Reference" and group these agentic processes in
their own section, distinct from CLI-managed primitives.

Remove the duplicated "Detailed Process" walkthrough from README.md
(and its TOC entry), repointing readers to the docs-site Quick Start
while keeping the concise "Get Started" section as the front door.

Assisted-by: GitHub Copilot (model: Claude Opus 4.8, supervised)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9d9232f8-ece4-4aa6-a9bd-ff8d74ca1c89
@mnriem

mnriem commented Jul 16, 2026

Copy link
Copy Markdown
Owner Author

Superseded by github#3565 — this change targets upstream, not the fork's main.

@mnriem mnriem closed this Jul 16, 2026
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.

1 participant