Repository navigation
docs: publish extensions overview and navigation - #5165
Merged
Merged
Conversation
Move the extension user guide into the docs site, group overview and publishing under Extensions, and align examples and links. Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The Copilot-specific documentation shows /speckit-jira-sync, but this alias is unavailable in default skills mode, which registers only primary command names.
No open issues 🎉
What changed in this PR
Publishes Spec Kit’s extension user guide on the documentation site and brings usage and publishing guidance together under a dedicated Extensions tab.
Changes:
- Moves the guide to Extensions Overview and updates navigation, while keeping Community Extensions under Community.
- Uses GitHub Copilot skills syntax, links shared invocation guidance, and corrects configuration filenames and support links.
- Updates inbound links and the existing hook-documentation test path.
| File | Description |
|---|---|
tests/extensions/bug/test_bug_hooks.py |
Points hook-documentation checks to the relocated guide. |
extensions/template/README.md |
Links to the published overview. |
extensions/README.md |
Updates the user-guide link. |
docs/toc.yml |
Adds the Extensions tab with Overview and Publishing. |
docs/README.md |
Lists the overview in the documentation structure. |
docs/extensions/overview.md |
Publishes the guide with updated examples, configuration guidance, and links. |
Review effort: Max
Remove alias examples and schema guidance from extension documentation without changing runtime support. Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
| @@ -44,7 +44,6 @@ provides: | |||
| - name: string # Required, pattern: ^speckit\.[a-z0-9-]+\.[a-z0-9-]+$ | |||
| file: string # Required, relative path to command file | |||
| description: string # Required | |||
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.
Description
Move the extension user guide to
docs/extensions/overview.mdand publish it as Extensions Overview. Add a top-level Extensions tab with Overview and the existing Publishing page; keep Community Extensions under Community.Use Copilot skills syntax for agent-facing examples, link to the shared integration invocation reference, and remove the duplicated automatic skill-registration section. Correct the local configuration filename and stale support links, and update inbound links and the existing hook-documentation test path.
Testing
Tested locally with
uv run specify --helpRan existing tests with
uv sync && uv run pytestTested with a sample project (if applicable)
uv run specify --help— passed..venv/bin/python -m pytest tests/extensions/bug/test_bug_hooks.py tests/test_extensions.py::TestConfigManagerNonMappingYaml tests/test_shared_infra_gitignore.py tests/test_catalog_trust_docs.py -q— 32 passed.docfx docs/docfx.json --logLevel Error— passed, no warnings or errors.Checked all 14 overview link destinations, rendered anchors, and updated inbound links; exercised the local browser preview.
The full test suite was not run. Sample-project testing is not applicable to this documentation-only change.
AI Disclosure
AI disclosure: GitHub Copilot using GPT-6.1 Sol (model ID: gpt-6.1-sol), runtime-default reasoning settings, autonomous execution with user-directed documentation revisions. Assistance covered documentation edits, navigation and link updates, an existing test-path update, validation, and this PR description.