docs(agents): simplify and refresh repository guidance - #176
Merged
Conversation
Signed-off-by: samzong <samzong.lu@gmail.com>
Contributor
Merging this PR will improve performance by 14.56%
|
| Benchmark | BASE |
HEAD |
Efficiency | |
|---|---|---|---|---|
| ⚡ | json-large |
3.4 ms | 3 ms | +14.56% |
Tip
Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.
Comparing docs/simplify-agent-guide (ce1ba88) with main (ac2f42c)
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
Simplify the repository agent guide from 98 to 45 lines by consolidating repeated product, architecture, and workflow guidance and linking to the existing contribution and contract documentation. Correct the description of overlays and align authentication guidance with the generated Skill's hostname/source inspection flow.
Verification
make checkgit diff --cached --checkbefore commitAGENTS.mdstill links toCLAUDE.md, the staged content matches the working file, all five documentation links resolve, and added lines contain no CJK text.Compatibility
Documentation only. Preserve the existing agent-guide entry point, architecture boundaries, generated-output restrictions, verification requirements, and release authorization rules. No generated CLI or catalog schema changes.
Checklist
internal/generated/,.cache/, and ad-hocskills/<cli-name>/directories is not committed.