इस प्रोजेक्ट के बारे में

सुंदर दस्तावेज़ एक क्यूरेटेड संदर्भ है जो उन लोगों के लिए है जो सॉफ़्टवेयर या कई उपयोगकर्ताओं के लिए बने अन्य परियोजनाओं के लिए दस्तावेज़ बनाते हैं। यह स्वयं दस्तावेज़ उत्पन्न नहीं करता; इसके बजाय, यह अच्छी तरह से माने जाने वाले उदाहरणों और सहायक संसाधनों से जोड़ता है। दस्तावेज़ीकरण के उदाहरण भाषा और फ्रेमवर्क संदर्भ, एपीआई गाइड, ऑपरेटिंग-सिस्टम मैनुअल, डेटाबेस और डेवलपर सेवाओं में फैले हुए हैं। प्रविष्टियों में Redis कमांड, GitHub डेवलपर दस्तावेज़, Django, Ruby on Rails, Stripe, Rust, MongoDB, FastAPI और Supabase शामिल हैं। कुछ प्रविष्टियाँ विशेष गुणों जैसे इंटरैक्टिव उदाहरण, संस्करण, खोज, संक्षिप्त लेखन, आरेख, नेविगेशन या भाषा समर्थन को उजागर करती हैं। दूसरा खंड तकनीकी-लेखन और दस्तावेज़-डिज़ाइन संसाधनों को कवर करता है, जिसमें TomDoc, Write the Docs, Google डेवलपर दस्तावेज़ीकरण शैली गाइड, API Blueprint और Diátaxis शामिल हैं। अंतिम खंड दस्तावेज़ उत्पन्न करने, परिवर्तित करने, प्रकाशित करने या बनाए रखने के लिए टूल सूचीबद्ध करता है, जैसे Sphinx, MkDocs, Read the Docs, Slate, Docusaurus, VuePress, VitePress, Docsify, Pandoc और Doxygen। रिपॉजिटरी पुल अनुरोधों के माध्यम से बनाए रखी जाती है। योगदानकर्ताओं से कहा जाता है कि वे बताएं कि कोई आइटम क्यों उपयोगी है, स्वयं या मूल योगदानकर्ता की पहचान करें, और सूची के जोड़ने के क्रम को संरक्षित रखें।