リファレンス
llms.txt
すべてのドキュメントページはプレーンなmarkdownでもあります: /llms.txtのインデックス、/llms-full.txtのコーパス全体、そして/raw/<path>.mdの任意のページ。
Polylaneのすべてのドキュメントページは、llms.txtの規約に従ってプレーンテキストとしても公開されているため、言語モデルやコーディングエージェントはブラウザーなしでドキュメントを読めます。
エンドポイント
| URL | 説明 |
|---|---|
| /llms.txt | タイトル、説明、そしてセクションごとにまとめたすべてのページのインデックス。それぞれに生のmarkdownのURLが付きます。 |
| /llms-full.txt | すべてのページの完全なmarkdownを1つのファイルにしたもの。 |
/raw/<path>.md | 1つのページを生のmarkdownとして、text/markdownで提供します。ドキュメントのパスの前に/raw/を付け、.mdを加えます。 |
たとえば、このページは/raw/reference/llms.mdで、自動修正のページは/raw/investigate/autofix.mdで提供されています。ページ本文がレベル1の見出しで始まらない場合、このルートはタイトルを見出しとして、説明を引用ブロックとして先頭に追加するため、ファイル単体で成立します。
どの場面で何を使うか
- Webアクセスのあるエージェント:
/llms.txtを指定すると、ドキュメントMCPサーバー、/raw/ルート、または通常のHTTP取得を通じて個々のページを取得できます。 - オフラインのプロンプトやファインチューニング:
/llms-full.txtを使って、ドキュメントを1つのコンテキストウィンドウやデータセットにまとめます。
関連
- ドキュメントMCPサーバー: 同じページをMCPのツールとリソースとして。
- APIリファレンス: プラットフォーム自体のホストされたOpenAPIリファレンス。