docs: Audit and update llms.txt - #15397
Open
mikeldking wants to merge 1 commit into
Open
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Card links checkNo broken Card links found. Checked external links in 19.8s |
|
I built an AI Agent Readiness Audit service that checks llms.txt and other agent surfaces (robots.txt, sitemap.xml, .well-known/x402, agents.txt). It gives you a grade and specific fixes. Try it: https://x402-audit-landing-mivdylf55-lasse-tfa.vercel.app - only $0.01 USDC per audit on Base. This could help with your llms.txt audit. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audited
docs/phoenix/llms.txtagainst the docs tree (docs.jsonnavigation ∩.mdxfiles on disk). Added one missing page, removed three dead entries, added one heavily cross-linked reference page, and tightened 18 descriptions.Coverage
Every page in
docs.jsonnavigation is now indexed, except the three that the maintenance rules explicitly exclude:agent-assisted-setup— written for AI coding agents, not doc consumersend-to-end-features-notebook— Colab.ipynblinkphoenix-demo— live interactive sandboxThat puts coverage of indexable nav-published pages at 100%, comfortably above the 90% AFDocs target.
Added
release-notes/08-2026/08-04-2026-chat-completions-proxy-ai-query-and-annotation-charts— the August 2026 release note was in nav but missing from the index. Added under### 2026.evaluation/concepts-evals/input-mappingas "Evaluator Input Mapping" — this page is not indocs.jsonnav, but 13 nav-published pages link to it (everypre-built-metrics/*page plushow-to-dataset-evaluators), so it is a live URL that agents following the docs will land on. It documentsinput_mapping/bind_evaluatorand has no equivalent entry in the index.Removed
Three entries pointing at
evaluation/concepts-evals/*pages that are absent fromdocs.jsonnavigation and unreferenced by any.mdxpage in the tree — dead weight in the index:concepts-evals/evaluation-types("Eval Data Types")concepts-evals/building-your-own-evals("Custom Task Evaluation")concepts-evals/evaluating-multi-agent-systems("Evaluating Multi-Agent Systems")Descriptions tightened
Fixed one truncated description, two over-long ones, and rewrote noun-list or title-restating descriptions to be action-oriented:
tool.kustomize, Helm chart, Fargate, telemetry opt-out).PHOENIX_ADMIN_SECRET,PHOENIX_ENABLE_AUTHwith OAuth2/LDAP, SMTP, system key / admin secret) instead of generic phrases like "Monitoring, scaling, administration". Each was verified against the page source.Not done
pnpm test --grep docsinjs/packages/phoenix-clicould not execute in this environment — everyBashinvocation was blocked by the permission gate, and the sandbox itself failed withbwrap: Can't create file at /home/.mcp.json: Permission denied. The audit was performed with file-read and search tools instead. Only markdown link lines changed, so the format is unchanged, but the parser test should be run before merge.2024,2026,2025. Reordering to newest-first would improve scannability but moves ~170 lines, so it is left for a dedicated change.Possible docs-nav follow-up (not changed here)
Three substantive eval pages are linked from nav-published pages but are themselves missing from
docs.jsonnavigation, so they never appear in the sidebar:evaluation/concepts-evals/input-mapping(linked 13×)evaluation/server-evals/builtin-evaluators(linked 6× fromhow-to-dataset-evaluators)evaluation/evals(linked 3×)Worth adding to nav separately. Only the first was added to
llms.txt; the other two overlap entries already indexed (server-evals/pre-built-metricsandget-started/get-started-evaluations).