docs(#5307): add interface documentation sync rule to AGENTS.md#5308
Open
fullsend-ai-coder[bot] wants to merge 1 commit into
Open
docs(#5307): add interface documentation sync rule to AGENTS.md#5308fullsend-ai-coder[bot] wants to merge 1 commit into
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
When code agents extend Go interfaces they do not check whether docs/guides/dev/ enumerates the interface's methods, causing avoidable stale-doc review findings and fix round-trips. Add an explicit sync rule — following the existing pattern for mint files and dispatch workflows — so agents know to update method listings when adding interface methods. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Site previewPreview: https://6414d2ce-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
docs/guides/dev/for documentation that enumerates an interface's methods when extending a Go interface, and update the listing to include all current methodsRelated Issue
Closes #5307
Changes
AGENTS.md: Added a new Interface documentation paragraph after the existing Dispatch workflows sync rule, before the "When making changes to Go code" checklistTesting
scan-secrets --staged)Checklist
docstype, issue scope)🤖 Generated with Claude Code
Closes #5307
Post-script verification
agent/5307-interface-doc-sync-guidance)24d41836a2de6b7abaa6b20be2bdac9a61f7e0d3..HEAD)