/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/إحالات مرجعية
/dependency-audit
/dependency-audit — مرور تدقيق لكلّ تبعية (المباشرة + المتعدّية) للتحقّق من الترخيص و<bdi>CVE</bdi> والحداثة.
/perf-audit
/perf-audit — يدقّق مقابل ميزانيات الأداء لكلّ صنف (زمن تشغيل الخطّافات، وverify-ecosystem، وبوابة المطابقة، والاختبارات، والعمّال المُفوَّضون، وshell، وlint)، باستخدام أسلوب USE.