Agent-friendliness requires maintenance. As your product changes and content accumulates, your documentation may stop being agent-friendly. Keeping it solid requires adding a few checks to the maintenance rhythms you should already have.Documentation Index
Fetch the complete documentation index at: https://learn.mintlify.com/llms.txt
Use this file to discover all available pages before exploring further.
Use your agent as a feedback loop
For the most direct signal about whether your documentation is agent-friendly, ask your preferred agent questions about your documentation. If it can’t answer a question well, that’s probably a documentation problem. Review agent responses regularly. Look for:- Questions it can’t answer: Relevant pages might have vague titles or descriptions. Terminology in your content may be inconsistent with the terminology in the question.
- Questions it answers incorrectly: Usually means a page is mixing topics, using ambiguous language, or relying on context the assistant doesn’t have.
- Questions it answers with outdated information: A page wasn’t updated when the product changed.
When the product changes
Documentation stops being agent-friendly the same way it stops being accurate: it was right once and then wasn’t updated. Agents don’t know when content is stale so they present it with the same confidence as current information. When a product changes or you release a new feature:- Update the relevant pages before or alongside the release, not after
- Check whether terminology has changed. If a feature was renamed, find every page that uses the old name and update it
- Update your
CLAUDE.mdandllms.txtif the change affects what’s important to surface or how to refer to things
Audit for terminology drift
Terminology consistency is hard to maintain as a team grows and different people contribute to documentation. Run a periodic audit:- List the canonical terms for your most important concepts in a shared style guide
- Search your documentation for synonyms and variants
- Update any pages using non-canonical terms
CLAUDE.md or Cursor rules file as your product grows. Define the name before contributors start writing about a new feature.
Check new pages are self-contained
Remember that every page needs to function as a standalone document. They need to be self-contained so that an agent (or human) can start on any page of your documentation and understand the content. Self-containment is the difficult to maintain because the problem is hard to spot while you’re writing. You have all the context so you may not notice that a page requires information that’s only available on another page. Add a self-containment check to your review process for new pages:- Does this page assume the reader has read any other page?
- Does it use terms that are only defined elsewhere?
- If a reader arrived here from an agent’s response, would they have enough context to act on what’s here?
Keep llms.txt current
Your llms.txt is a snapshot of your entire documentation site. Review it whenever you do a significant documentation update:
- Are there new pages that should be added?
- Is there content that’s been deprecated and should be removed?
- Are descriptions still accurate?
A maintenance rhythm
- With every product release: Update affected pages, check for terminology changes, review
CLAUDE.mdandllms.txtif relevant - Monthly: Review agent conversations for patterns like unanswered questions, wrong answers, or outdated information
- Quarterly: Audit for terminology drift; review
llms.txtto reflect new or removed content; check that high-traffic pages are self-contained
Go deeper
- Why agent-friendliness matters — An overview of how agents access documentation and why the highest-impact fixes are often configuration changes, not rewrites.
- The Agent-Friendly Documentation Spec — A spec that defines 22 checks for evaluating the agent-friendliness of your documentation.
Continue learning
- Structure docs that scale — Content types, navigation design, and keeping documentation accurate as your product grows
- Git and GitHub for docs teams — Version control, branching, and collaboration workflows for documentation
- Mintlify components — How to use Mintlify’s components to structure and format documentation effectively