CHORE - Fix command syntax in documentation - #4601
molson504x wants to merge 5 commits into
Conversation
…ckit.*` to `/speckit-*` format across multiple files for consistency and clarity. Adjust references in guides and concepts to reflect the correct command usage, ensuring accurate instructions for users.
There was a problem hiding this comment.
🟡 Changes recommended
Generic documentation now presents Copilot-specific syntax despite supported integrations using several invocation formats, and the SDD reference contradicts its own notation guidance.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Standardizes documentation examples on hyphenated GitHub Copilot skill syntax.
Changes:
- Converts core, extension, and assessment command examples to
/speckit-*. - Updates community catalog documentation descriptions accordingly.
File summaries
| File | Description |
|---|---|
docs/upgrade.md |
Updates upgrade examples. |
docs/reference/core.md |
Updates core command references. |
docs/reference/agentic-sdd.md |
Converts SDD workflow examples. |
docs/reference/agentic-bugfix.md |
Converts bug workflow examples. |
docs/reference/agentic-assessment.md |
Converts assessment examples. |
docs/installation.md |
Updates installed-command list. |
docs/guides/monorepo.md |
Updates monorepo examples. |
docs/guides/existing-projects.md |
Updates adoption workflow examples. |
docs/guides/evolving-specs.md |
Updates specification lifecycle examples. |
docs/concepts/spec-of-specs.md |
Updates decomposition workflow references. |
docs/concepts/complex-features.md |
Updates scoped implementation examples. |
docs/community/presets.md |
Updates preset descriptions. |
docs/community/extensions.md |
Updates extension descriptions. |
Review details
- Files reviewed: 13/13 changed files
- Comments generated: 9
- Review effort level: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Please address Copilot feedback where applicable. Note that I am fine with the Copilot skill syntax as the command shown. No need to repeat anywhere that the syntax might be different for different agents. Except for the installation page as there we have the one time someone could be picking another agent |
Co-authored-by: molson504x <4873425+molson504x@users.noreply.github.com>
Clarify installation verification commands as Copilot-specific
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
The Agentic SDD page still claims it uses dotted notation despite its converted examples.
Review effort: Balanced
Findings: 1
Open (1)
Resolved since last review (8)
This upgrade guidance applies to every integration, but/speckit-*is only one invocation style.… This generic core reference now presents GitHub Copilot's skill spelling as though all integrations… This verification section follows initialization for any selected integration, so this list is no… This guide is not scoped to a particular integration, but the replacement makes the runnable… The guide tells users to initialize with an arbitrary<key>at lines 12-16, then now instructs… This cross-integration guide now uses GitHub Copilot's skill spelling without saying so, although… This concept page is agent-neutral, but its workflow now uses only GitHub Copilot's default skill… This concept page is agent-neutral, but the examples now use only GitHub Copilot's default skill…
Co-authored-by: molson504x <4873425+molson504x@users.noreply.github.com>
…nds-docs Align agentic reference docs with hyphenated `/speckit-*` command syntax
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The integration reference no longer documents the supported dotted command syntax.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 1


This pull request standardizes command references throughout the documentation by converting all occurrences of slash-separated commands (e.g.,
/speckit.implement) to their hyphenated forms (e.g.,/speckit-implement). This improves consistency and aligns the docs with the current command naming conventions. The changes affect both the conceptual documentation and community extension/preset listings.The most important changes are:
Documentation consistency:
docs/concepts/complex-features.mdanddocs/concepts/spec-of-specs.mdfrom the old slash-dot format (e.g.,/speckit.implement) to the new slash-hyphen format (e.g.,/speckit-implement). [1] [2] [3] [4] [5] [6]Community extension and preset listings:
docs/community/extensions.mdanddocs/community/presets.mdto use hyphenated forms, ensuring extension descriptions and preset summaries are consistent with the new command syntax. [1] [2] [3] [4] [5] [6] [7] [8]These changes enhance clarity for users and reduce confusion by unifying command syntax across all documentation.