Skip to content

docs: Add ai.txt, llms.txt, and llms-full.txt for LLM discovery#225

Merged
evan-moon merged 1 commit into
toss:mainfrom
qkraudghgh:docs/add-llms-txt
May 21, 2026
Merged

docs: Add ai.txt, llms.txt, and llms-full.txt for LLM discovery#225
evan-moon merged 1 commit into
toss:mainfrom
qkraudghgh:docs/add-llms-txt

Conversation

@qkraudghgh
Copy link
Copy Markdown
Contributor

Summary

  • Add /ai.txt, /llms.txt, and /llms-full.txt at 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.txt is a navigable index of guides / API / design-system integrations. ai.txt carries canonical facts and "do not hallucinate" guardrails. llms-full.txt inlines 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).
  • Exempt the three text files from the nextra/locales i18n 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 dev then curl http://localhost:3939/ai.txt → HTTP 200, text/plain; charset=UTF-8, 4050 B
  • yarn dev then curl http://localhost:3939/llms.txt → HTTP 200, text/plain; charset=UTF-8, 5959 B
  • yarn dev then curl http://localhost:3939/llms-full.txt → HTTP 200, text/plain; charset=UTF-8, 27246 B
  • After deploy, verify https://overlay-kit.slash.page/{ai,llms,llms-full}.txt are reachable at the site root with no /en redirect.

🤖 Generated with Claude Code

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 qkraudghgh requested a review from jungpaeng as a code owner May 20, 2026 05:58
@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

@qkraudghgh is attempting to deploy a commit to the Toss Team on Vercel.

A member of the Team first needs to authorize it.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 20, 2026

⚠️ No Changeset found

Latest commit: 5f7ecce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.85%. Comparing base (4619b2f) to head (5f7ecce).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files          15       15           
  Lines        1340     1340           
  Branches      262      262           
=======================================
  Hits         1338     1338           
  Misses          2        2           
Components Coverage Δ
overlay-kit 99.85% <ø> (ø)
🚀 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.

@evan-moon evan-moon merged commit 26687b1 into toss:main May 21, 2026
9 of 10 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.

3 participants