📜 Nirvana README Architect (NRA)

فريق (Squad Protocol v5) يُنشئ ملف README.md المثالي لأي مشروع — يجمع بين التحليل العميق لقاعدة الكود، والاختيار الذكي للقوالب، وجميع ميزات GitHub Flavored Markdown، والتحقق بقائمة مراجعة من 25+ نقطة، والصقل النهائي.

الفهرس

• نظرة عامة
• الوكلاء
• خط الأنابيب
• البدء السريع
• الأوامر
• البنية
• ميزات GitHub المدعومة
• قائمة مراجعة الجودة
• استكشاف الأخطاء
• المساهمة
• الرخصة

نظرة عامة

Nirvana README Architect هو فريق من 5 وكلاء متخصصين يعملون في خط أنابيب لتحويل أي قاعدة كود إلى README بمستوى احترافي.

على عكس المولدات البسيطة التي تنتج قوالب عامة، NRA:

• يحلل قاعدة الكود الفعلية (المكدس التقني، النصوص، متغيرات البيئة، هيكل المجلدات)
• يختار القالب المثالي حسب نوع المشروع (مكتبة، CLI، تطبيق ويب، API، Monorepo، موبايل، فريق)
• يولّد المحتوى باستخدام جميع ميزات GitHub Flavored Markdown
• يتحقق بقائمة مراجعة من 25+ نقطة مع تسجيل تلقائي
• يصقل بالشارات، جدول المحتويات، الأقسام القابلة للطي، والتباعد المثالي

الوكلاء

خط الأنابيب

Parse → Scan → Draft → Validate → Polish → Revalidate → Deliver

البدء السريع

git clone https://github.com/gutomec/nirvana-readme-architect.git
squads install gutomec/nirvana-readme-architect

@nra-orchestrator
*readme {مسار-المشروع}

الأوامر

البنية

nirvana-readme-architect/
├── agents/          # 5 وكلاء متخصصين
├── tasks/           # 7 مهام قابلة للتنفيذ
├── workflows/       # خط أنابيب التوليد
├── checklists/      # 25+ نقطة تحقق
├── templates/       # قالب رئيسي مع GFM
├── config/          # المعايير والمكدس التقني
└── squad.yaml       # بيان الفريق

ميزات GitHub المدعومة

Alerts، Mermaid Diagrams، Tables، Collapsed Sections، Task Lists، Footnotes، Badges، Emojis، kbd Tags، Code Blocks، Diff Blocks، Reference Links — 12 ميزة كاملة.

قائمة مراجعة الجودة

استكشاف الأخطاء

المساهمة

المساهمات مرحب بها. اتبع Conventional Commits لرسائل الالتزام.

الرخصة

مرخص بموجب MIT — انظر LICENSE.