Skip to content

Add llms.txt for AI agent discoverability#266

Open
theAPILife wants to merge 2 commits intomainfrom
add-llms-txt
Open

Add llms.txt for AI agent discoverability#266
theAPILife wants to merge 2 commits intomainfrom
add-llms-txt

Conversation

@theAPILife
Copy link
Collaborator

Summary

  • Adds llms.txt at repo root with curated links to the most important documentation pages, API reference endpoints, and developer tools
  • Includes an Instructions section guiding AI agents away from deprecated patterns (GET translate, auth_key param, v2 glossaries)

Why

llms.txt is an emerging standard for helping AI agents and LLM-powered tools discover and correctly use APIs. This is a low-effort, high-impact addition — no existing files are modified.

Test plan

  • Verify llms.txt is served at the doc site root after deploy
  • Confirm all links resolve to valid pages
  • Review Instructions section for accuracy

🤖 Generated with Claude Code

Provides a machine-readable index of the most important DeepL API
documentation pages, API reference endpoints, and developer tools.
Includes an Instructions section guiding agents away from deprecated
patterns (GET translate, auth_key param, v2 glossaries).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Fix v2 glossary description: "maintained for backward compatibility" not "legacy"
- Complete document translation format list (add XLIFF, SRT, images)
- Add missing API entries: Style Rules, Admin API
- Add access limitation notes for Agent API, Voice API, Write API
- Add DeepL CLI to Developer Tools section
- Fix language count to explicit list
- Split 128 KiB and 50-segment limits into separate lines

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@shirgoldbird
Copy link
Member

@theAPILife Mintlify auto-generates this for us. Since theirs is automatically updated, I suggest we continue to use it to avoid unnecessary manual maintenance of this page.

@shirgoldbird shirgoldbird self-requested a review March 16, 2026 15:49
Copy link
Member

@shirgoldbird shirgoldbird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's discuss if additional customization to the llms.txt is worth the overhead of manual maintenance. I personally think no

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.

2 participants