📜 Nirvana README Architect (NRA)

स्क्वाड (Squad Protocol v5) जो किसी भी प्रोजेक्ट के लिए सटीक README.md बनाता है — गहन कोडबेस विश्लेषण, बुद्धिमान टेम्पलेट चयन, GitHub Flavored Markdown की सभी सुविधाएं, 25+ बिंदु चेकलिस्ट सत्यापन और अंतिम पॉलिशिंग का संयोजन।

विषय-सूची

• अवलोकन
• एजेंट
• पाइपलाइन
• शुरुआत
• कमांड
• आर्किटेक्चर
• समर्थित GitHub सुविधाएं
• गुणवत्ता चेकलिस्ट
• समस्या निवारण
• योगदान
• लाइसेंस

अवलोकन

Nirvana README Architect 5 विशेष एजेंटों का एक स्क्वाड है जो किसी भी कोडबेस को पेशेवर-स्तर की README में बदलने के लिए पाइपलाइन में काम करते हैं।

साधारण जनरेटर के विपरीत जो सामान्य टेम्पलेट बनाते हैं, NRA:

• वास्तविक कोडबेस का विश्लेषण करता है (टेक स्टैक, स्क्रिप्ट, एनवी वेरिएबल, डायरेक्टरी संरचना)
• प्रोजेक्ट प्रकार के अनुसार आदर्श टेम्पलेट चुनता है
• सभी GitHub Flavored Markdown सुविधाओं का उपयोग करके सामग्री बनाता है
• 25+ बिंदु चेकलिस्ट और स्वचालित स्कोरिंग के साथ सत्यापित करता है
• बैज, TOC, कोलैप्सिबल सेक्शन के साथ पॉलिश करता है

एजेंट

पाइपलाइन

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 देखें।