docs/docs/th/AGENTS.md
2026-04-23 10:27:44 +00:00

4.7 KiB

x-i18n
generated_at model provider source_hash source_path workflow
2026-04-23T10:13:32Z gpt-5.4 openai 8b046833f9a15dc61894ab9e808a09a9fb055ef7ada5c3d4893fbe5f70dec126 AGENTS.md 15

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

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

กฎของ Mintlify

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

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

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

เอกสาร i18n

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