You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: organize agent-specific integration documentation - #5034
Consolidates integration documentation under docs/integrations/, with a
top-level navigation menu and a dedicated page for each of the 43 registered
integrations, including none.
Separates agent-specific setup, invocation, options, safety, and limitations
from shared CLI, catalog, and contributor references.
Adds concise scenarios for adding, removing, and switching agents, including
an optional agent-neutral baseline for mixed-agent teams.
Updates incoming links and removes the superseded reference, contribution
page, and catalog-directory README without forwarding stubs.
Requires user-visible, agent-specific integration changes to update docs/integrations/<key>.md in the same change.
The guides were checked against the implementations on upstream main,
including the newly merged none integration, Kimi's stream-json output,
ZCode's unsupported model flag, and extension/preset cleanup on uninstall.
No CLI runtime behavior is changed. The CI follow-up removes the obsolete integrations/*.md lint glob and bumps the bundled GitHub extension and its
catalog entry to 1.0.3 to deliver the README updates, with a matching version
test assertion.
Testing
Tested locally with uv run specify --help
Ran existing tests with uv sync && uv run pytest
Tested with a sample project (if applicable)
The generic test command above was replaced by the targeted, worktree-local
invocations below, following the repository's virtualenv guidance. The full
repository suite was not run locally. Sample-project checks were automated.
uv sync --extra test — passed; refreshed this worktree's environment.
.venv/bin/python .github/scripts/check_extension_version_bump.py upstream/main HEAD — passed after the version bump; all invariants hold.
git diff --check — passed.
The stale-glob test and extension version guard both failed before the CI fixes
and passed afterward. The upstream Lint and Extension Version Guard
workflow runs also passed on commit 9610548e.
A session-local implementation audit exercised all 43 adapters' setup and
teardown behavior, generated paths, setup options, optional layouts, dispatch
arguments, model forwarding, unsupported runtime options, and cleanup
protections without invoking vendor agents. Navigation and per-agent
multi-install declarations match the registry. All 197 local article links and
anchors across the 47 rendered integration pages resolve.
AI Disclosure
I did not use AI assistance for this contribution
I did use AI assistance (fill in the disclosure below)
AI disclosure: Authored with GitHub Copilot using GPT-6.1 Sol
(gpt-6.1-sol), with autonomous execution under user direction. AI assistance
covered documentation organization and drafting, implementation audits,
upstream conflict resolution, CI configuration and extension version fixes,
and automated validation. No manual human line-by-line review or manual
testing is claimed.
The move removes the former descriptor-validation table, but this replacement gives only an example. It no longer states the external ID syntax and reserved names, the PEP 440 version requirement, or that requires.speckit_version is mandatory. These constraints are still enforced by IntegrationDescriptor._validate() and installer.validate_key(). Restore them in this descriptor reference so adapter authors can choose valid metadata before attempting installation.
Document the integration scaffold command
design/integration.md:423
specify integration scaffold still ships and generates a package plus a matching test skeleton (src/specify_cli/integrations/command_scaffold.py:23–40). This rewrite, together with the removed reference and local-development examples, leaves no documentation for that command. Restore a short example here or in the new contributor guide, including the repository-root requirement and supported --type values.
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
Important command and validation documentation was lost during the reorganization.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Document the integration scaffold command
docs/integrations/cli.md:493
The replacement reference omits specify integration scaffold, which is still registered in src/specify_cli/integrations/command_scaffold.py:23–33. This PR also removes its walkthrough from docs/local-development.md and its mention in design/integration.md, leaving the supported command undocumented. Restore a short reference here or in the linked contributor guide, including the repository-root requirement, supported --type values, and manual registry/catalog wiring.
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
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
Consolidates integration documentation under
docs/integrations/, with atop-level navigation menu and a dedicated page for each of the 43 registered
integrations, including
none.from shared CLI, catalog, and contributor references.
an optional agent-neutral baseline for mixed-agent teams.
page, and catalog-directory README without forwarding stubs.
docs/integrations/<key>.mdin the same change.The guides were checked against the implementations on upstream
main,including the newly merged
noneintegration, Kimi'sstream-jsonoutput,ZCode's unsupported model flag, and extension/preset cleanup on uninstall.
No CLI runtime behavior is changed. The CI follow-up removes the obsolete
integrations/*.mdlint glob and bumps the bundled GitHub extension and itscatalog entry to
1.0.3to deliver the README updates, with a matching versiontest assertion.
Testing
uv run specify --helpuv sync && uv run pytestThe generic test command above was replaced by the targeted, worktree-local
invocations below, following the repository's virtualenv guidance. The full
repository suite was not run locally. Sample-project checks were automated.
uv sync --extra test— passed; refreshed this worktree's environment.uv run specify --help— passed.LC_ALL=en_US.UTF-8 .venv/bin/python -m pytest tests/integrations tests/specify_cli/integrations tests/specify_cli/events tests/test_agent_config_consistency.py -q— 4,353 passed, 8 skipped.(cd docs && docfx docfx.json --logLevel Warning)with DocFX 2.81.0 — passed, 0 errors; three existing warnings (two unsupported parent-directory glob warnings and the existing file-helper link warning).LC_ALL=en_US.UTF-8 .venv/bin/python -m pytest tests/test_github_workflows.py tests/contract/test_extension_version_guard_script.py tests/contract/test_bundled_extension_versions.py tests/contract/test_bundled_extension_update_delivery.py tests/extensions/github/test_github_extension.py -q— 404 passed, 1 skipped after the CI fixes.npx --yes --package markdownlint-cli2@0.23.2 markdownlint-cli2 'docs/**/*.md' README.md README.zh-CN.md README.ja.md README.ko.md CODE_OF_CONDUCT.md CONTRIBUTING.md DEVELOPMENT.md SECURITY.md SUPPORT.md spec-driven.md 'presets/*.md' 'workflows/*.md'— passed; 107 files, 0 issues, using CI's exact CLI version and documentation globs..venv/bin/python .github/scripts/check_extension_version_bump.py upstream/main HEAD— passed after the version bump; all invariants hold.git diff --check— passed.The stale-glob test and extension version guard both failed before the CI fixes
and passed afterward. The upstream Lint and Extension Version Guard
workflow runs also passed on commit
9610548e.A session-local implementation audit exercised all 43 adapters' setup and
teardown behavior, generated paths, setup options, optional layouts, dispatch
arguments, model forwarding, unsupported runtime options, and cleanup
protections without invoking vendor agents. Navigation and per-agent
multi-install declarations match the registry. All 197 local article links and
anchors across the 47 rendered integration pages resolve.
AI Disclosure
AI disclosure: Authored with GitHub Copilot using GPT-6.1 Sol
(
gpt-6.1-sol), with autonomous execution under user direction. AI assistancecovered documentation organization and drafting, implementation audits,
upstream conflict resolution, CI configuration and extension version fixes,
and automated validation. No manual human line-by-line review or manual
testing is claimed.