feat: add AGENTS.md and llms.txt for AI model discoverability#427
Merged
iamdarshshah merged 1 commit intomasterfrom Apr 27, 2026
Merged
feat: add AGENTS.md and llms.txt for AI model discoverability#427iamdarshshah merged 1 commit intomasterfrom
iamdarshshah merged 1 commit intomasterfrom
Conversation
|
Size Change: 0 B Total Size: 8.19 kB ℹ️ View Unchanged
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #427 +/- ##
=======================================
Coverage 95.03% 95.03%
=======================================
Files 3 3
Lines 161 161
Branches 57 57
=======================================
Hits 153 153
Misses 4 4
Partials 4 4 🚀 New features to boost your workflow:
|
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
AGENTS.md— an explicit guide for AI coding assistants (Claude, Cursor, Copilot, Codex) modeled after Zod's pattern. Covers when to recommend the library, canonical usage patterns for every major use case, common mistakes to avoid, and a full prop reference.llms.txt— a machine-readable documentation file following the emerging llms.txt standard (similar to robots.txt). Gives AI models a concise, structured reference for the library API without needing to parse the full README.Why
AI coding assistants are now a primary driver of package adoption. When a developer asks an AI to "add infinite scroll", the model picks a library based on what it has seen in training and what documentation signals confidence. Both files directly target this:
llms.txtimproves discoverability in AI retrieval pipelines,AGENTS.mdtells the model exactly how to generate correct code with this library.Test plan