feat(docs): add AGENTS.md and AI Agent Integration docs page#171
Merged
Alberto-Codes merged 4 commits intomainfrom Feb 27, 2026
Merged
feat(docs): add AGENTS.md and AI Agent Integration docs page#171Alberto-Codes merged 4 commits intomainfrom
Alberto-Codes merged 4 commits intomainfrom
Conversation
Create AGENTS.md at repo root for cross-tool agent discovery (Codex, Cursor, Copilot, Windsurf, Kilo Code) with pure tool-usage content: six-layer quality model, install, run commands, configuration, and fix guidance. Add docs site page with copy-paste snippets for 5 agent tool formats. Wire mkdocs nav entry and README cross-link. Closes #161
Backtick-wrap URL template in AGENTS.md so <rule-id> placeholder renders visibly on GitHub instead of being stripped as an HTML tag. Align ai-integration.md intro to recommend `docvet check --all` consistently with all snippets on the page.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive AI agent integration documentation to the docvet project. It creates AGENTS.md at the repository root for cross-tool agent discovery and adds a new AI Agent Integration documentation page with copy-paste snippets for five different AI coding tools. The changes align with the AGENTS.md standard donated to the Agentic AI Foundation and provide users with ready-to-use integration snippets for OpenAI Codex, Cursor, GitHub Copilot, Claude Code, and Windsurf.
Changes:
- Created AGENTS.md (76 lines) with tool-usage focused content: quality model, installation, commands, configuration, and fix guidance
- Added ai-integration.md docs page with decision guide table and 5 tool-specific integration snippets
- Updated navigation and cross-links between README and docs site
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Repository-root agent discovery file with docvet usage guide including six-layer quality model, installation, commands, configuration, and fix guidance |
| docs/site/ai-integration.md | New docs page with decision guide table for 6 AI tools and 5 copy-paste integration snippets (AGENTS.md, CLAUDE.md, .cursorrules, .github/copilot-instructions.md, .windsurfrules) |
| mkdocs.yml | Added navigation entry for AI Agent Integration page after CI Integration |
| README.md | Added cross-link to full AI Agent Integration guide at beginning of AI Agent Integration section |
| _bmad-output/implementation-artifacts/sprint-status.yaml | Updated story 22-3 status from backlog to review and epic-16-retrospective to done |
| _bmad-output/implementation-artifacts/epic-16-retro-2026-02-26.md | Added Epic 16 retrospective documentation (internal project tracking) |
| _bmad-output/implementation-artifacts/22-3-create-agents-md-for-cross-tool-agent-discovery.md | Added comprehensive story documentation for 22-3 including ACs, tasks, dev notes, and code review findings |
Windsurf reads AGENTS.md natively — update table to match the existing Cursor and GitHub Copilot pattern for consistency.
This was referenced Feb 27, 2026
Alberto-Codes
added a commit
that referenced
this pull request
Feb 28, 2026
🤖 I have created a release *beep* *boop* --- ## [1.6.0](v1.5.0...v1.6.0) (2026-02-28) ### Features * **ci:** add cross-platform CI matrix and path normalization ([#174](#174)) ([e418fbc](e418fbc)), closes [#101](#101) * **ci:** add pre-commit hook definition and tests ([#180](#180)) ([5f11287](5f11287)) * **cli:** add --format json for structured machine-readable output ([#177](#177)) ([da8e51d](da8e51d)), closes [#151](#151) * **cli:** add positional file arguments to all subcommands ([#175](#175)) ([dee57cc](dee57cc)), closes [#152](#152) * **docs:** add "How to Fix" guidance to all 19 rule pages ([#166](#166)) ([817f43c](817f43c)), closes [#155](#155) * **docs:** add AGENTS.md and AI Agent Integration docs page ([#171](#171)) ([bc662a2](bc662a2)), closes [#161](#161) * **docs:** add AI Agent Integration section and enhance competitive positioning ([#170](#170)) ([df51114](df51114)), closes [#153](#153) [#162](#162) * **docs:** add CONTRIBUTING.md contributor guide ([#172](#172)) ([4ff286f](4ff286f)), closes [#104](#104) * **lsp:** add Claude Code plugin configuration ([#185](#185)) ([17be1f3](17be1f3)), closes [#63](#63) * **lsp:** add pygls-based LSP server for real-time diagnostics ([#184](#184)) ([e121c38](e121c38)), closes [#159](#159) * **reporting:** add format_json() for structured JSON output ([da8e51d](da8e51d)) ### Bug Fixes * **ci:** strengthen pre-commit hook YAML test assertions ([5f11287](5f11287)) * **docs:** code review fixes for AGENTS.md and ai-integration page ([bc662a2](bc662a2)) * **lsp:** decouple server global, narrow exception, fix handler test ([e121c38](e121c38)) ### Documentation * **cli:** document --format json schema and usage ([da8e51d](da8e51d)) * **meta:** reserve # references for GitHub issues and PRs only ([5f11287](5f11287)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
Add AGENTS.md at the repo root for cross-tool agent discovery and a new AI Agent Integration docs page with copy-paste snippets for 5 agent tool formats.
Test:
uv run mkdocs build --strictCloses #161
fix(docs): code review fixes for AGENTS.md and ai-integration page
PR Review
Checklist
uv run pytest)uv run ruff check .)uv run ty check)!in title andBREAKING CHANGE:in bodyReview Focus
Docs-only PR. Verify AGENTS.md renders correctly on GitHub (especially the backtick-wrapped URL template on line 69). Verify ai-integration.md snippets are consistent.
Related