समीक्षा

DocStar GitHub वर्कफ़्लो आपको GitHub रिपॉजिटरी के docs/ निदेशिका से Markdown दस्तावेज़ फाइलों को स्वचालित रूप से आपके DocStar संग्रह में समन्वयित करने की अनुमति देता है। जब भी कॉन्फ़िगर की गई शाखा (जैसे, main) पर एक पुश किया जाता है, GitHub क्रिया (Changes Detected) docs/ फ़ोल्डर में परिवर्तनों (जोड़ा गया, संशोधित, हटा दिया गया) का पता लगाती है और उन्हें DocStar संग्रह में भेजती है।

अपने प्रोजेक्ट में वर्कफ़्लो कैसे जोड़ें

DocStar समन्वय वर्कफ़्लो को अपने GitHub रिपॉजिटरी में एकीकृत करने के लिए, इन कदमों का पालन करें:

क़दम 1: वर्कफ़्लो फ़ाइल बनाएँ और सहेजें

अपने प्रोजेक्ट रिपॉजिटरी की जड़ में निम्नलिखित curl कमांड चलाएँ। <your-api-domain> को अपने वास्तविक API डोमेन और <collectionId> को अपने DocStar संग्रह ID से बदलें।

# यदि वर्कफ़्लो निर्देशिका अस्तित्व में नहीं है तो उसे बनाएँ

mkdir -p .github/workflows


# वर्कफ़्लो yaml फ़ाइल को सीधे वर्कफ़्लो में डाउनलोड करें

curl "https://api.docstar.io/p/generate-docstar-workflow/<collectionId>?branch=main" -o .github/workflows/docstar.yml


# DocStar Markdown स्पेसिफिकेशन फ़ाइल डाउनलोड करें।

curl "https://api.docstar.io/docstar.md" -o docstar.md

क़दम 2: GitHub सीक्रेट्स कॉन्फ़िगर करें

वर्कफ़्लो को DocStar बैकएंड के साथ सुरक्षित रूप से संप्रेषित करने के लिए एक API कुंजी की आवश्यकता होती है।

1. github.com पर अपने GitHub रिपॉजिटरी पर जाएँ।

2. सेटिंग्स > सीक्रेट्स और परिवर्तनीय > क्रियाएँ पर जाएँ।

3. नया रिपॉजिटरी सीक्रेट पर क्लिक करें।

4. सीक्रेट का नाम DOCSTAR_API_KEY रखें।

5. अपना DocStar API टोकन मान के रूप में पेस्ट करें और सहेजें।

क़दम 3: कमिट करें और पुश करें

नई वर्कफ़्लो फ़ाइल को कमिट करें और इसे अपने रिपॉजिटरी में पुश करें:

git add .github/workflows/docstar.yml
git commit -m "DocStar समन्वय वर्कफ़्लो जोड़ें"
git push origin main

एक बार पुश करने के बाद, docs/ निदेशिका के भीतर Markdown फ़ाइलों में किए गए कोई भी बाद के परिवर्तन स्वचालित रूप से GitHub क्रिया को ट्रिगर करेंगे और आपके DocStar संग्रह में समन्वयित करेंगे।

Docstar GitHub समन्वयन प्रारूप

यह दस्तावेज़ एक GitHub रिपॉजिटरी से Docstar में दस्तावेज़ों को समन्वयित करने के लिए तकनीकी विशिष्टताएँ प्रस्तुत करता है।

1. निदेशिका संरचना

सभी दस्तावेज़ों को एक मूल निर्देशिका (आमतौर पर docs/ नामित) के भीतर होना चाहिए। docs/ के भीतर फ़ोल्डर संरचना प्रकाशित साइट की पदानुक्रम और नेविगेशन को परिभाषित करती है।

• फ़ोल्डर्स: श्रेणियों या माता-पिता का प्रतिनिधित्व करते हैं।

• फ़ाइलें: व्यक्तिगत पृष्ठों या एंडपॉइंट्स का प्रतिनिधित्व करती हैं।

विशेष फ़ाइल: page.md

यदि किसी फ़ोल्डर में page.md फ़ाइल होती है, तो इस फ़ाइल की सामग्री उस विशेष फ़ोल्डर (सुपर पृष्ठ) के लिए सामग्री बन जाती है। page.md के बिना, फ़ोल्डर अपने बच्चों के लिए एक कंटेनर के रूप में कार्य करता है।

उदाहरण संरचना:

docs/
├── getting-started.md      (व्यक्तिगत पृष्ठ)
├── api/                    (फ़ोल्डर/श्रेणी)
│   ├── page.md             ('api' श्रेणी पृष्ठ के लिए सामग्री)
│   ├── authentication.md   ('api' के तहत पृष्ठ)
│   └── users/              (नेस्टेड फ़ोल्डर)
│       └── create.md       ('api/users' के तहत पृष्ठ)

2. फ़ाइल प्रारूप

फ़ाइलों को .md एक्सटेंशन का उपयोग करना चाहिए और YAML फ्रंटमैटर अनुभाग शामिल करें।

YAML फ्रंटमैटर

आवश्यक और वैकल्पिक फ़ील्ड:

उदाहरण पृष्ठ:

---
type: page
title: आरंभ करना
description: हमारे दस्तावेज़ में आपका स्वागत है।
published: true
---
# स्वागत है
यह पृष्ठ की Markdown सामग्री है।

3. API एंडपॉइंट्स (type: endpoint)

type: endpoint वाली फ़ाइलों के लिए, फ्रंटमैटर के नीचे की सामग्री को एक OpenAPI / Swagger टुकड़ा के रूप में रखा जाता है।

उदाहरण एंडपॉइंट:

---
type: endpoint
title: उपयोगकर्ता बनाएँ
published: true
---
post: /users
summary: एक नया उपयोगकर्ता बनाएँ
parameters:
  - name: username
    in: body
    required: true
    schema:
      type: string
responses:
  200:
    description: उपयोगकर्ता सफलतापूर्वक बनाया गया

4. समन्वयन तंत्र

Docstar GitHub क्रिया के माध्यम से समन्वय करता है जो /import/github एंडपॉइंट पर एक JSON पेलोड भेजता है।

5. AI के लिए नियमों का संक्षिप्त विवरण

• करें page.md का उपयोग करें फ़ोल्डर स्तर की सामग्री के लिए।

• करें प्रत्येक फ़ाइल में YAML फ्रंटमैटर शामिल करें।

• करें API दस्तावेज़ीकरण के लिए type: endpoint का उपयोग करें।

• करें एक साफ फ़ोल्डर पदानुक्रम बनाए रखें।

• न करें फ़ाइल/फ़ोल्डर नामों में a-z, 0-9, -, और _ के अलावा कोई अन्य वर्ण उपयोग करें (स्वच्छ URL सुनिश्चित करने के लिए)।