Repository navigation
docs: add AI agent instructions (AGENTS.md, AGENT_INSTRUCTIONS.md, llms.txt) - #542
Merged
Merged
Conversation
Move contributor guidance to AGENTS.md (CLAUDE.md now imports it), add docs/AGENT_INSTRUCTIONS.md for consumers and llms.txt as an index. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DsCpFqZQrQCCmrjaKRM9wm
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DsCpFqZQrQCCmrjaKRM9wm
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
2 participants
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.
Description
Makes the repo easy to use for AI agents (Claude, Codex, Copilot, Cursor, ...), with separate entry points for people who use the library and people who contribute to it.
Type of Change
Changes Made
AGENTS.md: formerCLAUDE.mdcontent (contributor guidance), with a header pointing consumers to the new guide.CLAUDE.mdnow just imports it with@AGENTS.md.docs/AGENT_INSTRUCTIONS.md: guide for integrating the library. Covers module choice (standard vs expressive), dependencies, component signatures taken from the source, minimal examples, groups/enabled state and common mistakes.llms.txt: index for LLMs.README.md: new "For AI agents" section..github/pull_request_template.mdandARCHITECTURE.md: references updated fromCLAUDE.mdtoAGENTS.md.Testing
Documentation only; nothing was compiled or run. Signatures were copied from the module sources.
Note: the README documents a
textStylesparameter that no component currently has. The new guide deliberately omits it; the README could be fixed separately.Checklist
Generated by Claude Code