Dokumentation für Menschen und Agenten veröffentlichen

Agentenlesbare Dokumentation sollte keine zweite, gekürzte Kopie der Site sein. Getrennte Content-Pipelines driften auseinander: Ein korrigiertes Beispiel erreicht die gerenderte Seite, während eine alte Antwort in einer Prompt-Datei oder einem privaten Index bleibt.

Ginko Docs beginnt mit einem Dokumentmodell und erzeugt daraus mehrere Darstellungen. Leser erhalten die vollständige Nuxt-Seite. Die Suche erhält normalisierte Datensätze. Statische Bereitstellungen enthalten Raw Markdown und Kataloge. Server-Bereitstellungen können Content Negotiation und MCP-Tools ergänzen.

Behalte explizite Markdown-URLs

Jede öffentliche Content-Route hat unter /raw eine explizite Variante mit der Endung .md. Ein Link zu dieser Datei funktioniert auf einem statischen Host, mit curl und in Werkzeugen, die keine eigenen Accept-Header senden können.

curl https://docs.example.com/raw/de/dokumentation/erste-schritte.md

Diese Schnittstelle ist besonders portabel, weil sie sich wie eine normale generierte Datei verhält.

Verwende Kataloge zur Erkundung

/llms.txt enthält eine kompakte Liste verfügbarer Seiten. /llms-full.txt kombiniert den öffentlichen Inhalt für Clients, die einen größeren Kontext bevorzugen. Lokalisierte Sites erzeugen zusätzlich sprachspezifische Kataloge.

Kataloge lösen die Erkundung, aber weder Ranking noch Zugriffsschutz. Halte private Dokumentation aus der öffentlichen Collection heraus, statt von einem LLM-Katalog Zugriffskontrolle zu erwarten.

Ergänze Laufzeitschnittstellen bewusst

Ein Nitro-Server kann für eine normale Seiten-URL Markdown zurückgeben, wenn der Request Accept: text/markdown sendet. Er kann außerdem /mcp bereitstellen. Dort liefert list-pages den Standardkatalog und get-page das Raw Markdown für einen angegebenen öffentlichen Pfad.

Diese Funktionen benötigen Servercode. Ein statischer Host behält die Raw-Routen und Kataloge, kann aber weder Antworten aushandeln noch MCP-Tools ausführen.

Erhalte die Bedeutung eigener Komponenten

Standard-Markdown lässt sich direkt übertragen. Eine eigene Komponente braucht manchmal mehr Aufmerksamkeit. Ginko Docs registriert sichere Standard-Serializer für die eingebauten Tags. Sie erzeugen eine XML-ähnliche Komponentendarstellung mit statischen Props und gerenderten Kindern.

Wenn eine Komponente semantische Informationen anders darstellen soll – etwa einen API-Explorer, Benchmark oder Produktstatus –, registriere einen Serializer über @lupinum/ginko-content/agent-registry. Halte ihn beim Komponentenvertrag, damit visuelle und maschinenlesbare Änderungen gemeinsam geprüft werden.

Der Leitfaden zur agentenlesbaren Ausgabe enthält die Bereitstellungsmatrix und Konfigurationsgrenzen. Prüfe nach einer semantischen Komponentenänderung die gerenderte Seite, Raw-Route und den Katalogeintrag; alle drei müssen dieselbe Aussage enthalten.