docs(#844): add skill documentation altitude guidance - #845
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#844): add skill documentation altitude guidance#845fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add section 3 to AGENTS.md establishing that SKILL.md files should stay at the directive altitude — describing what to detect, match, and report — rather than prescribing specific CLI commands, API queries, or pagination strategies. When a skill references external data, it should name the data source and fields needed, not the retrieval commands. This guidance prevents skill docs from drifting into engineering specifications that create fragile platform coupling and expand review surface area, as observed in PR #540's 7-round review cycle. Sections 3–8 renumbered to 4–9 to accommodate the new section. Note: pre-commit could not run in sandbox (network access blocked for git fetch). The post-script will run pre-commit authoritatively. Closes #844
|
🤖 Finished Review · ✅ Success · Started 1:06 PM UTC · Completed 1:28 PM UTC Commit: |
ReviewFindingsMedium
Labels: Docs-only change to AGENTS.md adding skill documentation altitude guidance. |
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
Context
PR #540 went through 7 review rounds over 18 days as a conceptual skill doc addition progressively expanded into a detailed engineering specification. The core issue was an altitude mismatch: skill documentation drifted from "what patterns to detect" into "how to query GitHub Actions APIs." This guidance gives reviewers a citable standard to flag that drift early.
Test plan
Closes #844
Post-script verification
agent/844-skill-doc-altitude)1a3086f5512b3700ab8e081c689cc7586c9af20f..HEAD)