คู่มือเอกสาร

ไดเรกทอรีนี้รับผิดชอบการเขียนเอกสาร กฎลิงก์ของ Mintlify และนโยบาย i18n ของเอกสาร

กฎของ Mintlify

• เอกสารถูกโฮสต์บน Mintlify (https://docs.openclaw.ai)
• ลิงก์เอกสารภายในใน docs/**/*.md ต้องคงเป็นแบบสัมพันธ์จากราก โดยไม่มีส่วนต่อท้าย .md หรือ .mdx (ตัวอย่าง: [Config](/gateway/configuration))
• การอ้างอิงข้ามส่วนควรใช้แองเคอร์บนพาธแบบสัมพันธ์จากราก (ตัวอย่าง: [Hooks](/gateway/configuration-reference#hooks))
• หัวข้อเอกสารควรหลีกเลี่ยงขีดยาวและอะพอสทรอฟี เพราะการสร้างแองเคอร์ของ Mintlify เปราะบางกับอักขระเหล่านั้น
• README และเอกสารอื่นที่เรนเดอร์โดย GitHub ควรคง URL เอกสารแบบสมบูรณ์ไว้ เพื่อให้ลิงก์ทำงานนอก Mintlify ได้
• เนื้อหาเอกสารต้องคงความเป็นทั่วไป: ไม่มีชื่ออุปกรณ์ส่วนตัว ชื่อโฮสต์ หรือพาธในเครื่อง; ใช้ตัวยึดตำแหน่ง เช่น user@gateway-host

กฎเนื้อหาเอกสาร

• สำหรับเอกสาร ข้อความ UI และรายการตัวเลือก ให้เรียงบริการ/ผู้ให้บริการตามตัวอักษร เว้นแต่ส่วนนั้นจะอธิบายลำดับรันไทม์หรือลำดับการตรวจจับอัตโนมัติอย่างชัดเจน
• รักษาการตั้งชื่อ Plugin ที่บันเดิลมาให้สอดคล้องกับกฎคำศัพท์ Plugin ทั่วทั้งรีโปใน AGENTS.md ที่ราก

เอกสารภายใน

• เอกสารผู้ปฏิบัติการแบบส่วนตัวที่ใช้งานระยะยาวควรอยู่ใน ~/Projects/manager/docs/
• เอกสารร่าง/มิเรอร์ภายในที่อยู่ในรีโปอาจอยู่ใต้ docs/internal/ ที่ถูกละเว้น
• ห้ามเพิ่มหน้า docs/internal/** ลงในการนำทางของ docs/docs.json หรือเชื่อมลิงก์จากเอกสารสาธารณะ
• scripts/docs-sync-publish.mjs จะยกเว้นและตัด docs/internal/** ออกจากรีโปเผยแพร่สาธารณะ openclaw/docs หากมีหน้าใดถูกบังคับเพิ่มในภายหลัง
• เอกสารภายในอาจกล่าวถึงพาธรีโป ชื่อแอปส่วนตัว ชื่อรายการ 1Password และคู่มือปฏิบัติการได้ แต่ห้ามรวมค่าความลับ

การแก้ไขสกอร์การ์ดวุฒิภาวะ

taxonomy.yaml และ qa/maturity-scores.yaml เป็นอินพุตต้นทาง; เอกสารวุฒิภาวะที่สร้างขึ้นใต้ docs/maturity/ เป็นภาพฉาย และไม่ควรแก้ไขด้วยมือสำหรับคะแนน, LTS, อนุกรมวิธาน, โปรไฟล์ QA หรือตารางหลักฐาน scripts/qa/render-maturity-docs.ts รับผิดชอบการสร้าง; ใช้ pnpm maturity:render เพื่อรีเฟรชเอกสารที่คอมมิต และ pnpm maturity:check เพื่อตรวจสอบ .github/workflows/maturity-scorecard.yml เรนเดอร์ตัวอย่างอาร์ติแฟกต์และสามารถเปิด PR เอกสารที่สร้างขึ้นได้; .github/workflows/openclaw-release-checks.yml จะเรียกใช้สำหรับ QA ของรุ่นปล่อย เก็บข้อมูล qa-evidence.json.scorecard ที่กำหนดได้ซ้ำแน่นอนในอาร์ติแฟกต์ GitHub Actions เว้นแต่ผู้ดูแลจะขอภาพฉายที่ล้างข้อมูลแล้วและคอมมิตไว้อย่างชัดเจน การแทนที่โดยมนุษย์ต้องเปลี่ยนสถานะต้นทางใน PR และอธิบายเหตุผลพร้อมหลักฐานสาธารณะหรือหลักฐานที่ปกปิดข้อมูลแล้ว

i18n ของเอกสาร

• เอกสารภาษาต่างประเทศไม่ได้ดูแลในรีโปนี้ ผลลัพธ์เผยแพร่ที่สร้างขึ้นอยู่ในรีโป openclaw/docs แยกต่างหาก (มักถูกโคลนในเครื่องเป็น ../openclaw-docs)
• ห้ามเพิ่มหรือแก้ไขเอกสารที่แปลแล้วใต้ docs/<locale>/** ที่นี่
• ถือว่าเอกสารภาษาอังกฤษในรีโปนี้พร้อมไฟล์อภิธานศัพท์เป็นแหล่งข้อมูลจริง
• ไปป์ไลน์: อัปเดตเอกสารภาษาอังกฤษที่นี่ อัปเดต docs/.i18n/glossary.<locale>.json ตามจำเป็น จากนั้นให้การซิงก์รีโปเผยแพร่และ scripts/docs-i18n ทำงานใน openclaw/docs
• ก่อนรัน scripts/docs-i18n ซ้ำ ให้เพิ่มรายการอภิธานศัพท์สำหรับคำศัพท์ทางเทคนิคใหม่ ชื่อหน้า หรือป้ายกำกับการนำทางแบบสั้นที่ต้องคงเป็นภาษาอังกฤษหรือใช้คำแปลคงที่
• pnpm docs:check-i18n-glossary เป็นตัวป้องกันสำหรับชื่อเอกสารภาษาอังกฤษที่เปลี่ยนแปลงและป้ายกำกับเอกสารภายในแบบสั้น
• หน่วยความจำการแปลอยู่ในไฟล์ docs/.i18n/*.tm.jsonl ที่สร้างขึ้นในรีโปเผยแพร่
• ดู docs/.i18n/README.md