Dokumentacja referencyjna
llms.txt
Każda strona dokumentacji to także zwykły markdown: indeks pod /llms.txt, cały korpus pod /llms-full.txt i dowolna strona pod /raw/<path>.md.
Każda strona dokumentacji Polylane jest też publikowana jako zwykły tekst zgodnie z konwencją llms.txt, więc model językowy albo agent kodujący może czytać dokumentację bez przeglądarki.
Punkty końcowe
| URL | Opis |
|---|---|
| /llms.txt | Tytuł, opis i indeks każdej strony pogrupowany według sekcji, każda z adresem URL surowego markdownu. |
| /llms-full.txt | Pełny markdown każdej strony w jednym pliku. |
/raw/<path>.md | Jedna strona jako surowy markdown, serwowana jako text/markdown. Poprzedź ścieżkę dokumentacji /raw/ i dodaj .md. |
Na przykład ta strona jest serwowana pod /raw/reference/llms.md, a strona autofixu pod /raw/investigate/autofix.md. Gdy treść strony nie zaczyna się nagłówkiem pierwszego poziomu, trasa dodaje na początku tytuł jako nagłówek i opis jako cytat blokowy, żeby plik był samodzielny.
Kiedy używać którego
- Agent z dostępem do sieci: wskaż mu
/llms.txt, żeby mógł pobierać pojedyncze strony przez serwer MCP dokumentacji, trasy/raw/albo zwykłe żądanie HTTP. - Prompty offline albo fine-tuning: użyj
/llms-full.txt, żeby spakować dokumentację do jednego okna kontekstu albo zbioru danych.
Powiązane
- Serwer MCP dokumentacji: te same strony jako narzędzia i zasoby MCP.
- Dokumentacja API: hostowana dokumentacja OpenAPI samej platformy.