Klassieke documentatie gemaakt voor mensen: gerenderde HTML, syntaxhighlighting, sidebar, zoekfunctie. Maar steeds vaker bezoekt docs niet een mens, maar een agent - Claude, Cursor, ChatGPT - waar deze rendering alleen maar in de weg staat. Hij heeft een schoon tekst en een machine-leesbare contract nodig.
We hebben documentatie geschikt voor beide. Hieronder wat erachter zit.
.md-kopie van elke pagina
Section titled “.md-kopie van elke pagina”Elke pagina van de content-documentatie heeft een schoon Markdown-kopie met dezelfde pad met een .md-suffixed. Als je /agent-setup opent, is er ook /agent-setup.md, met dezelfde tekst zonder HTML-wrapping, MDX-imports afgesneden, wordt geleverd als text/markdown.
Dit voedt twee acties in de pagina-menu: Copy as Markdown (zet schoon tekst in de clipboard, om in te plakken in een chat met een model) en View as Markdown (opent .md-versie rechtstreeks). De agent hoeft de DOM niet te parsen - hij krijgt de schoon tekst.
Dropdown acties bovenin pagina
Section titled “Dropdown acties bovenin pagina”In de rechter bovenhoek van elke pagina - menu acties, gemaakt voor agent-workflow:
- Copy as Markdown - schoon tekst van de pagina in de clipboard
- View as Markdown - openen
.md-kopie - Open in ChatGPT - overdragen pagina naar ChatGPT met één klik
- Open in Claude - hetzelfde voor Claude
- Connect MCP - overdragen naar MCP-server-instellingen
In plaats van “kopieer URL, open chat, vraag om in te loggen op pagina” - één actie.
llms.txt en llms-full.txt
Section titled “llms.txt en llms-full.txt”Volgens de standaard llmstxt.org geven we twee bestanden:
/llms.txt- index van alle pagina’s documentatie, gegroepeerd in secties (API Reference, Use Cases, Examples, Products). Kaart voor agent, van waaruit beginnen./llms-full.txt- alle documentatie in één plain-text bestand. Voor offline-indexatie in een vectorische database of éénmalig invoeren in context van een model.
Als je bouwt RAG bovenop ons API, llms-full.txt - het is een complete corpus, geen noodzaak om de site te crawlen.
Machine-leesbare specificaties
Section titled “Machine-leesbare specificaties”Contract wordt geleverd in verschillende formaten voor verschillende tools:
/v1/openapi.json- canonische OpenAPI 3.1-specificatie met voorbeelden en code-samples. Voor code-generatie van clients en elk OpenAPI-tool.- Swagger-aliases -
/v1/swagger.json,/v1/v3/api-docsen andere 301-redirecten naar canon, zodat tools die naar de gebruikelijke paden zoeken, niet struikelen. - Postman-collectie -
/postman/astroway-api.jsonvoor importeren in Postman met één klik.
/agent-setup onder specifieke clients
Section titled “/agent-setup onder specifieke clients”Pagina /agent-setup/ - niet één algemene gids, maar aparte instructies voor zes clients: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Codex. Elke geeft exacte configuratie en curl-forbeeld tools/list, om te controleren voordat je code schrijft.
Inline try-it
Section titled “Inline try-it”Op pagina’s van de API-documentatie heeft elke operatie een ingebouwd try-it widget: je voert sandbox-sleutel in, bewerk je lichaam van de vraag, druk op “Send” - en je ziet de echte respons, zonder uit de docs te stappen. Methode, pad en voorbeeld lichaam worden genomen van al reeds gegenereerde curl-snippet, dus de widget doet geen extra vragen naar openapi.json.
Waarom dit alles
Section titled “Waarom dit alles”Eenvoudige thesis: als je product een API is, moet de documentatie geschikt zijn niet alleen voor lezen met ogen, maar ook voor verbruiken door een agent. De helft van de integraties vandaag begint met dat de ontwikkelaar een link naar docs in Claude of Cursor gooit en vraagt “verbinding maken”. We hebben het gemaakt zodat er schoon tekst en een machine-leesbaar contract zijn, in plaats van HTML die moet worden geparses.
Dezelfde Swiss Ephemeris als in Solar Fire - in 4 regels code.
Gratis sleutel zonder kaart. 5.000 calls per maand tot de eerste betaling.