Skip to content

docs: move extension API reference into documentation - #5174

Merged
mnriem merged 3 commits into
github:mainfrom
mnriem:mnriem-extension-api-documentation
Oct 29, 2026
Merged

mnriem merged 3 commits into
github:mainfrom
mnriem:mnriem-extension-api-documentation

Conversation

@mnriem

@mnriem mnriem commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator

Description

Move the Extension API Reference from extensions/EXTENSION-API-REFERENCE.md to docs/extensions/api.md without 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

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

Used 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

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

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.

Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI auto review requested due to automatic review settings October 29, 2026 12:29

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.

🟢 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)

@mnriem mnriem added the triage-nice-to-have Verdict: evidence-backed fix or greenlit feature — land after review label Oct 29, 2026
Assisted-by: GitHub Copilot (model: GPT-6.1 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI auto review requested due to automatic review settings October 29, 2026 13:23

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.

🟢 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>
Copilot AI auto review requested due to automatic review settings October 29, 2026 14:11

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.

🟢 Approval recommended

The documentation relocation is accompanied by coordinated updates to navigation, links, test references, and related version metadata, with no active review issues identified.

No open issues 🎉

Review effort: Lite (auto)

@mnriem
mnriem merged commit d605a15 into github:main Oct 29, 2026
16 checks passed
@mnriem
mnriem deleted the mnriem-extension-api-documentation branch October 29, 2026 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage-nice-to-have Verdict: evidence-backed fix or greenlit feature — land after review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants