Repository navigation
docs: llms.txt efficiency work - #96
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Warning Polylane could not verify the production impact of this pull request. This change touches only documentation content and docs.json (descriptions, agent instructions, /runtime/* redirects) for the Mintlify-hosted docs site. No production resource runs it: datum-cloud/docs has no deploy edge in the graph, and docs.json parses cleanly. Also considered · 1 refuted
Analysed against 2 cloud accounts and 1 repository
Polylane could not find the cloud resources this repository manages, so this review looked at the entire cloud account. Connect this repository to its resources and the next review will focus on exactly what this code deploys to. Polylane analysed Did this help? React 👍 or 👎 so the next review is sharper. |
|
From Claude: |
|
|
a810982 to
53dc1d9
Compare
|
This is the second of hopefully only two "re-org" PRs, the first was #81 . This PR does a couple of things:
In an effort to avoid making changes for changes sake, I am try to figure out how to measure these changes as much as possible, so I've built a little local test suite that drives subagents through a series of tests related to docs understanding. In this table, the The main wins of the changes in this repo are:
From what I can tell, there is real quantitative improvement in the "underpowered" agent experience with the docs repo with the contents here. RFR / RFM |
|
Also just a note that I tried to cover the still relevant changes in #52 as well. |
721edb1 to
ad4b602
Compare
Make the docs easier for agents and humans to navigate and act on: - llms.txt guidance in docs.json (description, markdown instructions, For agents link) and the agents/llms-txt page - human-first page titles and descriptions, with answers and cross-links in the body - explicit "not documented yet" notes where the docs are silent (token lifetime, availability commitments, audit retention) - ALB, DNS, domains, compute and datumctl fixes: diff/apply exit-code gating, GitOps action input, finding crashed Instance names, rollback by redeploy, whoami variants - DNS: correct the "zone stuck at PROGRAMMED=False" row (verification, not delegation), explain Rejected on unverified zones, and list what does not carry over on a zone import - Mintlify style fixes from PRs 92, 84 and 76 (sentence-case headings, active voice, DNSSEC jargon) - merged with current main (Private DNS, plugin install pages, layout revamp, datumctl patch/label/annotate); Client Traffic stays marked not available yet
ad4b602 to
d4720a3
Compare
llms.txt is important enough to the AX that we should re-orient some things around it