docs: Add ai.txt, llms.txt, and llms-full.txt for LLM discovery#225
Conversation
Publishes machine-readable docs at the site root following the llmstxt.org and aitxt.ing standards so LLM crawlers and agents can index overlay-kit's public API directly. - llms.txt: navigable index of guides, API, and design-system integrations. - ai.txt: canonical facts plus "do not hallucinate" guardrails for the public API surface. - llms-full.txt: inlined core English docs (guides, more, API reference). Marketing landing, verbose test code, and per-design- system walkthroughs are excluded as noise. - middleware: exempt the three text files from nextra/locales i18n routing so they respond at the site root instead of being 307-redirected to /en/.... Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
@qkraudghgh is attempting to deploy a commit to the Toss Team on Vercel. A member of the Team first needs to authorize it. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #225 +/- ##
=======================================
Coverage 99.85% 99.85%
=======================================
Files 15 15
Lines 1340 1340
Branches 262 262
=======================================
Hits 1338 1338
Misses 2 2
🚀 New features to boost your workflow:
|
Summary
/ai.txt,/llms.txt, and/llms-full.txtat the docs site root, following the llmstxt.org and aitxt.ing standards, so LLM crawlers and agents can index overlay-kit's public API directly without scraping the rendered Nextra site.llms.txtis a navigable index of guides / API / design-system integrations.ai.txtcarries canonical facts and "do not hallucinate" guardrails.llms-full.txtinlines the core English docs; the marketing landing, verbose test code in the Testing guide, and the per-design-system walkthroughs (MUI / Chakra UI / Ant Design) are intentionally excluded as noise (see the file header).nextra/localesi18n middleware so they respond at the site root (/llms.txt) instead of being 307-redirected to/en/llms.txt— required by both standards.Test plan
yarn devthencurl http://localhost:3939/ai.txt→ HTTP 200,text/plain; charset=UTF-8, 4050 Byarn devthencurl http://localhost:3939/llms.txt→ HTTP 200,text/plain; charset=UTF-8, 5959 Byarn devthencurl http://localhost:3939/llms-full.txt→ HTTP 200,text/plain; charset=UTF-8, 27246 Bhttps://overlay-kit.slash.page/{ai,llms,llms-full}.txtare reachable at the site root with no/enredirect.🤖 Generated with Claude Code