Skip to content
Apothem
पाइपलाइन कमांड

/docs-review

/docs-review — गद्य-परंपराओं और दस-आयामी गुणवत्ता मानकों के विरुद्ध दस्तावेज़ीकरण समीक्षा पास।

भूमिका: दस्तावेज़ीकरण समीक्षक पाइपलाइन स्थिति: फ़ोर्ट्रेस

गद्य-परंपराओं और दस-आयामी गुणवत्ता मानकों के विरुद्ध दस्तावेज़ीकरण समीक्षा पास।

विहित आह्वान

/docs-review

तर्कों के साथ:

/docs-review [path/to/repo/ or path/to/docs-source/] [--focus FILE_OR_DIR] [--dry-run]

इनपुट

होस्ट रिपॉज़िटरी की दस्तावेज़ीकरण सतह

आउटपुट

दस्तावेज़ीकरण निष्कर्ष _inputs/docs-review-findings.md पर

अनुप्रवाह

ऑडिट समीक्षा अनुक्रम का दस्तावेज़ीकरण-समीक्षा चरण

वर्कफ़्लो फ़ेज़

यह कमांड पाँच चरण चलाता है: इनपुट इनजेस्ट, प्रति-पृष्ठ वॉक, प्रति-निष्कर्ष छँटाई, निष्कर्ष उत्सर्जन, और सत्यापन गेट।

विफलता मोड

लक्षणकारणपुनर्प्राप्ति
गुणवत्ता गेट FAILआउटपुट मानकों पर खरा नहीं उतरताआउटपुट ठीक करें और पुनः चलाएँ
इनपुट फ़ाइल अनुपस्थितइस पथ पर कोई दस्तावेज़ फ़ाइल पहुँच योग्य नहीं हैऐसी रिपॉज़िटरी रूट या दस्तावेज़ स्रोत डायरेक्टरी दें जिसमें Markdown पृष्ठ हों

उदाहरण

# Dry-run to preview what would happen
/docs-review --dry-run

# Execute against a repository root
/docs-review path/to/repo/

क्रॉस-संदर्भ

On this page