Skip to content

docs: add workflows reference, reorganize into docs/reference/, and add --version flag#2244

Merged
mnriem merged 2 commits intogithub:mainfrom
mnriem:docs/add-workflows-reference-and-reorganize
Apr 16, 2026
Merged

docs: add workflows reference, reorganize into docs/reference/, and add --version flag#2244
mnriem merged 2 commits intogithub:mainfrom
mnriem:docs/add-workflows-reference-and-reorganize

Conversation

@mnriem
Copy link
Copy Markdown
Collaborator

@mnriem mnriem commented Apr 16, 2026

Adds a workflows reference page, reorganizes all reference docs into docs/reference/, renames the workflow feature_name input to spec, and adds a --version flag to the root specify command.

Changes

Docs reorganization

  • Move docs/integrations.md, docs/extensions.md, docs/presets.mddocs/reference/
  • Update docs/toc.yml, README.md links, and docs/upgrade.md cross-reference to use reference/ paths

New workflows reference

  • New 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 FAQ
  • Add workflow command to the README CLI reference table with link to published docs

Workflow input rename

  • Rename feature_namespec with prompt "Describe what you want to build" in workflows/speckit/workflow.yml to match the /speckit.specify command terminology ("describe what you want to build")
  • Update workflows/README.md, workflows/PUBLISHING.md, src/specify_cli/workflows/expressions.py docstring, and tests/test_workflows.py fixtures

CLI --version flag

  • Add --version / -V flag to the root specify command
  • New tests/test_cli_version.py with 3 tests covering long flag, short flag, and precedence over subcommands

Tests

All 1485 tests pass.

…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
Copilot AI review requested due to automatic review settings April 16, 2026 18:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_namespec across workflow YAML, docs, and tests.
  • Added --version / -V to 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

Comment thread docs/reference/workflows.md Outdated
@mnriem mnriem merged commit 02a1d61 into github:main Apr 16, 2026
11 checks passed
@mnriem mnriem deleted the docs/add-workflows-reference-and-reorganize branch April 16, 2026 19:59
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.

2 participants