Repository navigation
docs: move extension API reference into documentation - #5174
Merged
Merged
Conversation
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.
🟢 Approval recommended
The review found no active issues, and the change consistently updates the documentation location, navigation, links, and path-sensitive test references.
No open issues 🎉
What changed in this PR
This pull request moves the Extension API Reference into the published documentation tree and updates navigation, extension links, and test references to the new location without changing the reference content.
Changes:
- Relocated the API reference to
docs/extensions/api.md. - Added it to the Extensions documentation navigation.
- Updated extension README links and path-sensitive test references.
| File | Description |
|---|---|
tests/test_extensions.py |
Updates documentation path references for extension tests. |
tests/extensions/bug/test_bug_hooks.py |
Checks hook-event documentation at the relocated path. |
extensions/template/README.md |
Links contributors to the published API reference. |
extensions/github/README.md |
Updates the manifest API reference link. |
extensions/bug/README.md |
Updates the hook contract reference link. |
docs/toc.yml |
Adds the API reference to the Extensions navigation. |
docs/extensions/api.md |
Provides the relocated Extension API Reference documentation. |
Review effort: Lite (auto)
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.
🟢 Approval recommended
The relocation and associated links, navigation, version metadata, and test references are synchronized, with only two noted documentation-consistency nits and no active blocking issues.
No open issues 🎉
Review effort: Lite (auto)
Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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 API Reference from
extensions/EXTENSION-API-REFERENCE.mdtodocs/extensions/api.mdwithout changing its contents, so it is published with the extension documentation. Add it to the documentation navigation and update README links and test references to the new location.Testing
uv run specify --helpuv sync && uv run pytestUsed the worktree-local interpreter as recommended by CONTRIBUTING.md:
uv sync --extra test --quiet— passed.LC_ALL=en_US.UTF-8 .venv/bin/python -m pytest tests -q— passed: 13,661 passed, 130 skipped..venv/bin/python -m pytest tests/extensions/bug/test_bug_hooks.py -q— passed: 19 passed.uv run specify --help— passed.A sample project is not applicable to this documentation relocation.
AI Disclosure
AI disclosure: GitHub Copilot App using GPT-6.1 Sol (model ID: gpt-6.1-sol), autonomous agent execution at the contributor's direction; reasoning effort was not exposed. The agent moved the documentation, updated navigation, links and test references, ran automated checks, and authored the commit and PR description.