docs: document copilot skills mode (--skills) and markdown deprecation#3313
docs: document copilot skills mode (--skills) and markdown deprecation#3313Quratulain-bilal wants to merge 4 commits into
Conversation
as of github#3256 (v0.12.3) the copilot integration supports a skills mode via `--integration-options "--skills"`, and installing without it warns that the legacy markdown default is being phased out. this was undocumented: - the copilot row in the supported-agents table had an empty notes cell while other skills-capable agents describe their behavior there. - `--skills` was missing from the integration-specific options table (only generic and kimi were listed). fill both. wording matches the code: skills scaffold as speckit-<name>/SKILL.md under .github/skills/ and are invoked as /speckit-<name>; without the flag the install emits the deprecation warning from _warn_legacy_markdown_default(). fixes github#3300
There was a problem hiding this comment.
Pull request overview
Updates the integration reference documentation to cover GitHub Copilot’s --skills mode (introduced in v0.12.3) and to note the deprecation warning for Copilot’s legacy markdown-based default scaffold.
Changes:
- Adds a detailed Notes entry for the GitHub Copilot row in the supported agents table, including
--integration-options "--skills"behavior and deprecation messaging. - Adds a
copilot/--skillsentry to the Integration-Specific Options table.
Show a summary per file
| File | Description |
|---|---|
| docs/reference/integrations.md | Documents Copilot skills mode usage and adds the missing integration-specific option entry. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback. If not applicable, please explain why
…prompt.md) the copilot rows said the default installs .agent.md files, but the default scaffold also writes companion .prompt.md files under .github/prompts/. also reworded to 'legacy markdown mode' to match the deprecation warning users actually see and to avoid ambiguity, since skills are markdown too.
|
both correct. pushed 43f23af: both copilot rows now say the default is legacy markdown mode and spell out the .agent.md + companion .prompt.md (.github/prompts/) layout, and use the 'legacy markdown mode' wording that matches the deprecation warning users see instead of the ambiguous 'markdown default'. |
|
Please address Copilot feedback |
…pilot rows address the follow-up copilot review: name where the default scaffold writes files (.github/agents/*.agent.md plus .github/prompts/*.prompt.md and a .vscode/settings.json merge), and switch speckit-<name> to speckit-<command> to match the rest of the table. verified all three paths against the copilot integration source.
|
addressed in 37414d1. both copilot rows now spell out the legacy markdown layout (.github/agents/.agent.md plus .github/prompts/.prompt.md and the .vscode/settings.json merge) and use speckit- to match the rest of the table. verified each path against the copilot integration source (folder .github/, agents dir .github/agents, prompts .github/prompts, and the settings.json write). |
| | [Forge](https://forgecode.dev/) | `forge` | | | ||
| | [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `gemini` | | | ||
| | [GitHub Copilot](https://code.visualstudio.com/) | `copilot` | | | ||
| | [GitHub Copilot](https://code.visualstudio.com/) | `copilot` | Defaults to legacy markdown mode: `.agent.md` command files under `.github/agents/`, companion `.prompt.md` files under `.github/prompts/`, and a `.vscode/settings.json` merge. Pass `--integration-options "--skills"` to scaffold skills as `speckit-<command>/SKILL.md` under `.github/skills/` instead. Legacy markdown mode is deprecated and will stop being the default in a future release. | |
|
Please address Copilot feedback |
match the equals form the rest of the doc uses (generic row, the options table, and the install example) so readers don't mistake the quotes for part of the value. addresses copilot review feedback.
|
addressed in b3935ca. the copilot notes cell now uses |
fixes #3300
as suggested by @mnriem on the issue.
what
the copilot skills mode (added in #3256, v0.12.3) wasn't documented in
docs/reference/integrations.md:--skillswas missing from the integration-specific options table — onlygenericandkimiwere listed.how
.agent.mdby default;--integration-options "--skills"scaffoldsspeckit-<name>/SKILL.mdunder.github/skills/; the markdown default is deprecated.copilot/--skillsrow to the integration-specific options table.verified against the code
CopilotIntegration.options()insrc/specify_cli/integrations/copilot/__init__.pydefines--skillsas a flag with help "Scaffold commands as agent skills (speckit-/SKILL.md) instead of .agent.md files".dispatch_commanduses.github/skills/,speckit-<stem>/SKILL.md, and invokes/speckit-<stem>in skills mode;--agent speckit.<stem>otherwise._warn_legacy_markdown_default()emits the deprecation warning when installing without--skills.docs-only change.
note: i used an ai assistant to help investigate and write this up.