Skip to content

CHORE - Fix command syntax in documentation - #4601

Open
molson504x wants to merge 5 commits into
github:mainfrom
molson504x:chore/update-docs-with-correct-agent-skill-commands
Open

molson504x wants to merge 5 commits into
github:mainfrom
molson504x:chore/update-docs-with-correct-agent-skill-commands

Conversation

@molson504x

Copy link
Copy Markdown

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:

  • Updated all command references in docs/concepts/complex-features.md and docs/concepts/spec-of-specs.md from 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:

  • Standardized command references in docs/community/extensions.md and docs/community/presets.md to 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.

…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.
@molson504x
molson504x requested a review from mnriem as a code owner September 15, 2026 20:42
Copilot AI balanced review requested due to automatic review settings September 15, 2026 20:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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.

Comment thread docs/concepts/complex-features.md
Comment thread docs/concepts/spec-of-specs.md
Comment thread docs/guides/evolving-specs.md
Comment thread docs/guides/existing-projects.md
Comment thread docs/guides/monorepo.md
Comment thread docs/installation.md
Comment thread docs/reference/agentic-sdd.md
Comment thread docs/reference/core.md
Comment thread docs/upgrade.md
@mnriem mnriem added the triage-can-wait Verdict: valid and in-scope but deprioritized; held behind the evidence gate label Sep 16, 2026
@mnriem

mnriem commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

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

@mnriem mnriem added the author-awaiting Waiting on author response label Sep 17, 2026
Copilot AI and others added 2 commits September 19, 2026 17:33
Co-authored-by: molson504x <4873425+molson504x@users.noreply.github.com>
Clarify installation verification commands as Copilot-specific
Copilot AI review requested due to automatic review settings September 19, 2026 17:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Copilot AI and others added 2 commits September 19, 2026 17:41
Co-authored-by: molson504x <4873425+molson504x@users.noreply.github.com>
…nds-docs

Align agentic reference docs with hyphenated `/speckit-*` command syntax
Copilot AI review requested due to automatic review settings September 19, 2026 17:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 Medium severity

Open (1)
Resolved since last review (1)

Comment thread docs/reference/integrations.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author-awaiting Waiting on author response triage-can-wait Verdict: valid and in-scope but deprioritized; held behind the evidence gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants