เอกสารอ้างอิง
llms.txt
ทุกหน้าเอกสารยังเป็น markdown ธรรมดาด้วย: ดัชนีที่ /llms.txt ทั้งชุดที่ /llms-full.txt และหน้าใดก็ได้ที่ /raw/<path>.md
ทุกหน้าเอกสารของ Polylane ยังถูกเผยแพร่เป็นข้อความธรรมดาผ่านธรรมเนียม llms.txt ดังนั้นโมเดลภาษาหรือเอเจนต์เขียนโค้ดอ่านเอกสารได้โดยไม่ต้องใช้เบราว์เซอร์
Endpoint
| URL | คำอธิบาย |
|---|---|
| /llms.txt | ชื่อเรื่อง คำอธิบาย และดัชนีของทุกหน้าจัดกลุ่มตามส่วน แต่ละหน้าพร้อม URL ของ markdown ดิบ |
| /llms-full.txt | markdown เต็มของทุกหน้าในไฟล์เดียว |
/raw/<path>.md | หน้าหนึ่งหน้าเป็น markdown ดิบ ให้บริการเป็น text/markdown เติม /raw/ หน้า path ของเอกสารและต่อท้ายด้วย .md |
ตัวอย่างเช่น หน้านี้ให้บริการที่ /raw/reference/llms.md และหน้า autofix ที่ /raw/investigate/autofix.md เมื่อเนื้อหาของหน้าไม่ได้เริ่มด้วยหัวเรื่องระดับหนึ่ง route จะเติมชื่อเรื่องเป็นหัวเรื่องและคำอธิบายเป็น blockquote ไว้ด้านหน้า เพื่อให้ไฟล์อยู่ได้ด้วยตัวเอง
เมื่อใดควรใช้อะไร
- เอเจนต์ที่เข้าถึงเว็บได้: ชี้มันไปที่
/llms.txtเพื่อให้ดึงหน้าแต่ละหน้าผ่านเซิร์ฟเวอร์ MCP ของเอกสาร route/raw/หรือการดึงผ่าน HTTP ธรรมดาได้ - พรอมต์แบบออฟไลน์หรือการ fine-tune: ใช้
/llms-full.txtเพื่อรวมเอกสารไว้ใน context window หรือชุดข้อมูลเดียว
ที่เกี่ยวข้อง
- เซิร์ฟเวอร์ MCP ของเอกสาร สำหรับหน้าเดียวกันในรูปเครื่องมือและทรัพยากร MCP
- เอกสารอ้างอิง API สำหรับเอกสารอ้างอิง OpenAPI ที่โฮสต์ไว้ของแพลตฟอร์มเอง