docs(#6232): add skill doc-integration checklist to AGENTS.md - #6235
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#6232): add skill doc-integration checklist to AGENTS.md#6235fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add a rule to the "How to work in this repo" section instructing
contributors to check user-facing guides for cross-reference
opportunities when adding a new skill under skills/. The rule
names the three most relevant guide files (customizing-with-skills,
bring-your-own-agent, guides README) and uses advisory phrasing
("check for opportunities") to avoid unnecessary boilerplate when
a skill does not warrant user-guide integration.
Motivated by PR #6202, where the initial commit created a skill
file without updating any existing documentation, requiring a
human rewrite to add cross-references in three guide files.
Closes #6232
|
🤖 Finished Review · ✅ Success · Started 5:00 PM UTC · Completed 5:10 PM UTC Commit: |
ReviewFindingsMedium
Labels: PR modifies AGENTS.md (governance file) with a rule about skills/ directory doc integration |
fullsend-ai-review
Bot
added
requires-manual-review
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.
Summary
Add a doc-integration checklist rule to AGENTS.md so that contributors adding new skills under
skills/check the user-facing guides for cross-reference opportunities.Related Issue
Closes #6232
Changes
AGENTS.md, placed after the existing documentation guidance rules (vitepress sidebar config and stale-reference grep)docs/guides/user/customizing-with-skills.md,docs/guides/user/bring-your-own-agent.md, anddocs/guides/README.mdTesting
make lint— docs-only change, no Go or test code modifiedChecklist
!for breaking changes)Closes #6232
Post-script verification
agent/6232-agents-skill-doc-checklist)4bfc8988be00438547d53e2d4ab1fa4211563eaa..HEAD)