docs: add workflows reference, reorganize into docs/reference/, and add --version flag#2244
Merged
mnriem merged 2 commits intogithub:mainfrom Apr 16, 2026
Conversation
…dd --version flag - Move integrations.md, extensions.md, presets.md into docs/reference/ - New docs/reference/workflows.md: command reference for all workflow commands, built-in SDD Cycle workflow with Mermaid diagram, step types, expressions, input types, state/resume, and FAQ - Rename workflow input feature_name to spec with prompt 'Describe what you want to build' to match speckit.specify command terminology - Add --version / -V flag to root specify command with tests - Update docs/toc.yml, README.md links, and docs/upgrade.md cross-reference to use reference/ paths - Add workflow command to README CLI reference table
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Spec Kit’s documentation structure and workflow UX while adding a root specify --version flag to improve CLI ergonomics.
Changes:
- Reorganized docs reference pages under
docs/reference/, updated TOC and README links, and added a new Workflows reference page. - Renamed the Speckit workflow input from
feature_name→specacross workflow YAML, docs, and tests. - Added
--version/-Vto the root CLI with dedicated test coverage.
Show a summary per file
| File | Description |
|---|---|
| workflows/speckit/workflow.yml | Updates required Spec Kit version and renames workflow input to spec. |
| workflows/README.md | Updates workflow usage examples to use spec input. |
| workflows/PUBLISHING.md | Updates publishing guide examples to use spec input. |
| tests/test_workflows.py | Updates fixtures/assertions for the renamed workflow input. |
| tests/test_cli_version.py | Adds tests for --version / -V behavior and precedence. |
| src/specify_cli/workflows/expressions.py | Updates expression docstring example to inputs.spec. |
| src/specify_cli/init.py | Adds root --version / -V eager option and callback. |
| docs/upgrade.md | Fixes link to new docs/reference/integrations.md path. |
| docs/toc.yml | Points reference entries to docs/reference/* and adds Workflows. |
| docs/reference/workflows.md | New workflows command/reference documentation. |
| docs/reference/presets.md | Moved/added presets reference page under docs/reference/. |
| docs/reference/integrations.md | Moved/added integrations reference page under docs/reference/. |
| docs/reference/extensions.md | Moved/added extensions reference page under docs/reference/. |
| README.md | Updates published docs links and adds workflow command entry/link. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 11/14 changed files
- Comments generated: 1
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.
Adds a workflows reference page, reorganizes all reference docs into
docs/reference/, renames the workflowfeature_nameinput tospec, and adds a--versionflag to the rootspecifycommand.Changes
Docs reorganization
docs/integrations.md,docs/extensions.md,docs/presets.md→docs/reference/docs/toc.yml,README.mdlinks, anddocs/upgrade.mdcross-reference to usereference/pathsNew workflows reference
docs/reference/workflows.md— command reference for all workflow CLI commands, built-in Full SDD Cycle workflow with Mermaid diagram, 10 step types, expressions, input types, state/resume, catalog management, and FAQworkflowcommand to the README CLI reference table with link to published docsWorkflow input rename
feature_name→specwith prompt "Describe what you want to build" inworkflows/speckit/workflow.ymlto match the/speckit.specifycommand terminology ("describe what you want to build")workflows/README.md,workflows/PUBLISHING.md,src/specify_cli/workflows/expressions.pydocstring, andtests/test_workflows.pyfixturesCLI --version flag
--version/-Vflag to the rootspecifycommandtests/test_cli_version.pywith 3 tests covering long flag, short flag, and precedence over subcommandsTests
All 1485 tests pass.