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

ไดเรกทอรีนี้ดูแลการเขียนเอกสาร กฎเกี่ยวกับลิงก์ของ Mintlify และนโยบาย i18n สำหรับเอกสาร

กฎของ Mintlify

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

กฎเกี่ยวกับเนื้อหาเอกสาร

• สำหรับเอกสาร ข้อความใน UI และรายการตัวเลือก ให้เรียงบริการ/ผู้ให้บริการตามลำดับตัวอักษร เว้นแต่ส่วนนั้นจะอธิบายลำดับการทำงานขณะรันหรือลำดับการตรวจหาอัตโนมัติโดยชัดเจน
• ตั้งชื่อ Plugin ที่รวมมาให้สอดคล้องกับกฎคำศัพท์เกี่ยวกับ Plugin ที่ใช้ทั่วทั้งรีโพซิทอรีใน AGENTS.md ที่ราก
• เอกสารต่อไปนี้สร้างขึ้นอัตโนมัติ ห้ามแก้ไขด้วยตนเอง: docs/plugins/reference/**, docs/plugins/reference.md และ docs/plugins/plugin-inventory.md สร้างจาก pnpm plugins:inventory:gen; docs/docs_map.md สร้างจาก pnpm docs:map:gen; docs/maturity/** สร้างจาก pnpm maturity:render

เอกสารภายใน

• เอกสารส่วนตัวสำหรับผู้ปฏิบัติงานที่ใช้งานระยะยาวควรอยู่ใน ~/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