Skip to content

feat: add AGENTS.md and llms.txt for AI model discoverability#427

Merged
iamdarshshah merged 1 commit intomasterfrom
feat/ai-discoverability
Apr 27, 2026
Merged

feat: add AGENTS.md and llms.txt for AI model discoverability#427
iamdarshshah merged 1 commit intomasterfrom
feat/ai-discoverability

Conversation

@iamdarshshah
Copy link
Copy Markdown
Collaborator

Summary

  • Adds 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.
  • Adds 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.txt improves discoverability in AI retrieval pipelines, AGENTS.md tells the model exactly how to generate correct code with this library.

Test plan

  • No source code changes, CI passes unchanged
  • Both files are plain Markdown, no build impact

@github-actions
Copy link
Copy Markdown

Size Change: 0 B

Total Size: 8.19 kB

ℹ️ View Unchanged
Filename Size
dist/index.es.js 4.09 kB
dist/index.js 4.1 kB

compressed-size-action

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.03%. Comparing base (810f915) to head (53d0e4e).
⚠️ Report is 4 commits behind head on master.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@iamdarshshah iamdarshshah merged commit b53588b into master Apr 27, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant