दस्तावेज़ मार्गदर्शिका

यह डायरेक्टरी दस्तावेज़ लेखन, 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 का नामकरण रूट AGENTS.md में दिए गए पूरे रिपॉज़िटरी के Plugin शब्दावली नियमों के अनुरूप रखें।
• जनरेट किए गए दस्तावेज़ों को कभी हाथ से संपादित न करें: 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 सार्वजनिक openclaw/docs प्रकाशन रिपॉज़िटरी से docs/internal/** को बाहर रखता और हटाता है।
• आंतरिक दस्तावेज़ों में रिपॉज़िटरी पथ, निजी ऐप नाम, 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 आर्टिफ़ैक्ट पूर्वावलोकन रेंडर करता है और जनरेट किए गए दस्तावेज़ों के पुल रिक्वेस्ट खोल सकता है; .github/workflows/openclaw-release-checks.yml रिलीज़ QA के लिए इसे डिस्पैच करता है। नियतात्मक qa-evidence.json.scorecard डेटा को GitHub Actions आर्टिफ़ैक्ट में रखें, जब तक कि कोई अनुरक्षक स्पष्ट रूप से स्वच्छीकृत कमिट किए गए प्रक्षेपण का अनुरोध न करे। मानवीय ओवरराइड को पुल रिक्वेस्ट में स्रोत स्थिति बदलनी चाहिए और कारण के साथ सार्वजनिक या संशोधित साक्ष्य की व्याख्या करनी चाहिए।

दस्तावेज़ i18n

• इस रिपॉज़िटरी में विदेशी-भाषा के दस्तावेज़ों का रखरखाव नहीं किया जाता। जनरेट किया गया प्रकाशन आउटपुट अलग openclaw/docs रिपॉज़िटरी में रहता है (जिसे अक्सर स्थानीय रूप से ../openclaw-docs के रूप में क्लोन किया जाता है)।
• यहाँ docs/<locale>/** के अंतर्गत स्थानीयकृत दस्तावेज़ न जोड़ें और न संपादित करें।
• इस रिपॉज़िटरी के अंग्रेज़ी दस्तावेज़ों और शब्दावली फ़ाइलों को सत्य का स्रोत मानें।
• पाइपलाइन: यहाँ अंग्रेज़ी दस्तावेज़ अपडेट करें, आवश्यकतानुसार docs/.i18n/glossary.<locale>.json अपडेट करें, फिर प्रकाशन-रिपॉज़िटरी सिंक और openclaw/docs में scripts/docs-i18n को चलने दें।
• scripts/docs-i18n को दोबारा चलाने से पहले, ऐसे किसी भी नए तकनीकी शब्द, पृष्ठ शीर्षक या छोटे नेविगेशन लेबल के लिए शब्दावली प्रविष्टियाँ जोड़ें, जिन्हें अंग्रेज़ी में बनाए रखना या किसी निश्चित अनुवाद का उपयोग करना आवश्यक है।
• pnpm docs:check-i18n-glossary बदले गए अंग्रेज़ी दस्तावेज़ शीर्षकों और छोटे आंतरिक दस्तावेज़ लेबलों के लिए सुरक्षा जाँच है।
• अनुवाद स्मृति प्रकाशन रिपॉज़िटरी में जनरेट की गई docs/.i18n/*.tm.jsonl फ़ाइलों में रहती है।
• docs/.i18n/README.md देखें।