docs: document spec persistence models#2856
Open
wondr-wclabs wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Concepts documentation page describing three “spec persistence” models (flow-back, flow-forward, living spec) and wires it into the docs navigation so teams can explicitly choose how they maintain spec.md/plan.md/tasks.md over time.
Changes:
- Added a new concept page: Spec Persistence Models.
- Linked the new page from the What is SDD? concept page.
- Added the new page to the docs table of contents (
docs/toc.yml).
Show a summary per file
| File | Description |
|---|---|
| docs/toc.yml | Adds the new concept page to the Concepts section navigation. |
| docs/concepts/spec-persistence.md | Introduces the new concept page defining and comparing three spec persistence models. |
| docs/concepts/sdd.md | Links readers to the new page from the SDD overview. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 0
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
Adds a new concept page that documents three spec-persistence models discussed in #2831:
The page explains that Spec Kit does not enforce or prefer any one model, then links the new page from the SDD concept page and docs table of contents.
Closes #2832
Testing
npx --yes markdownlint-cli2 docs/concepts/spec-persistence.md docs/concepts/sdd.mdgit diff --checkruby -e 'require "yaml"; YAML.load_file("docs/toc.yml"); puts "toc ok"'uv run specify --help(not applicable: docs-only change)uv sync && uv run pytest(not run: docs-only change)DocFX was not run locally because
dotnet/docfxare not installed in my environment.AI Disclosure
This PR was written with AI agent assistance in Codex. I reviewed the issue/discussion context, followed the contribution guidance, made the docs changes, and ran the validation listed above.