डॉक्यूमेंटेशन, AI-एजेंट्स के लिए बनाया गया, न कि केवल लोगों के लिए

К्लासिक डॉक्यूमेंटेशन इंसान के लिए बनाई गई है: रेंडर्ड HTML, सिंटैक्स हाईलाइट, साइडबार, सर्च। लेकिन अब अक्सर docs पर इंसान नहीं, बल्कि एजेंट - Claude, Cursor, ChatGPT - जाता है, जिसे ये रेंडर सिर्फ बाधा बनता है। उसे चाहिए साफ़ टेक्स्ट और मशीन‑रीडेबल कॉन्ट्रैक्ट।

हमने डॉक्यूमेंटेशन दोनों के लिए उपयुक्त बना दिया है। ये है अंदर क्या है।

हर कंटेंट‑डॉक्यूमेंटेशन पेज का एक कच्चा Markdown‑डुप्लिकेट उसी पाथ पर .md सुफ़िक्स के साथ होता है। /agent-setup खोलो - वहाँ /agent-setup.md भी है, वही टेक्स्ट बिना HTML रैपर के, MDX‑इम्पोर्ट हटाए हुए, text/markdown के रूप में दिया जाता है।

यह पेज मेन्यू में दो एक्शन देता है: Copy as Markdown (साफ़ टेक्स्ट को क्लिपबोर्ड में रखता है ताकि मॉडल के साथ चैट में पेस्ट कर सको) और View as Markdown (.md‑वर्ज़न सीधे खोलता है)। एजेंट को DOM पार्स करने की ज़रूरत नहीं - वह तैयार टेक्स्ट ले लेता है।

पेज के दाहिने ऊपर कोने में - एक्शन मेन्यू, खास एजेंट वर्कफ़्लो के लिए बनाया गया:

• Copy as Markdown - पेज का साफ़ टेक्स्ट क्लिपबोर्ड में
• View as Markdown - .md‑डुप्लिकेट खोलो
• Open in ChatGPT - पेज को एक क्लिक में ChatGPT को भेजो
• Open in Claude - वही Claude के लिए
• Connect MCP - MCP‑सर्वर सेटअप पर जाओ

‘URL कॉपी करो, चैट खोलो, पेज खोलने को कहो’ की जगह - एक ही एक्शन।

स्टैंडर्ड llmstxt.org के अनुसार हम दो फाइलें देते हैं:

• /llms.txt - डॉक्यूमेंटेशन के सभी पेजों का इंडेक्स, सेक्शन (API Reference, Use Cases, Examples, Products) में समूहित। एजेंट के लिए मैप, कहाँ से शुरू करें।
• /llms-full.txt - पूरी डॉक्यूमेंटेशन एक plain‑text फाइल में। ऑफ़लाइन‑इंडेक्सिंग के लिए वेक्टर डेटाबेस में या मॉडल के कॉन्टेक्स्ट में एक बार पेस्ट करने के लिए।

अगर तू हमारे API के ऊपर RAG बना रहा है, llms-full.txt तैयार कॉर्पस है, साइट को क्रॉल करने की ज़रूरत नहीं।

कॉन्ट्रैक्ट कई फॉर्मैट में विभिन्न टूल्स के लिए दिया जाता है:

• /v1/openapi.json - कैनोनिकल OpenAPI 3.1‑स्पेसिफिकेशन उदाहरणों और code‑samples के साथ। क्लाइंट कोड जेनरेशन और किसी भी OpenAPI‑टूलिंग के लिए।
• Swagger‑एलियासेज़ - /v1/swagger.json, /v1/v3/api-docs और अन्य 301‑रिडायरेक्ट करके कैनन पर ले जाते हैं, ताकि वो टूल्स जो सामान्य पाथ ढूँढते हैं, फँसे नहीं।
• Postman‑कलेक्शन - /postman/astroway-api.json Postman में एक क्लिक से इम्पोर्ट करने के लिए।

पेज /agent-setup/ सिर्फ एक सामान्य गाइड नहीं, बल्कि सात क्लाइंट्स के लिए अलग‑अलग निर्देश है: Claude Desktop, Claude Code, Cursor, VS Code, Windsurf, Cline, Codex। हर एक सटीक कॉन्फ़िग और tools/list का curl‑उदाहरण देता है, ताकि कोड लिखने से पहले कनेक्शन चेक कर सको।

API रेफ़रेंस पेजों पर हर ऑपरेशन में इनबिल्ट try-it विजेट है: sandbox‑की डालो, रिक्वेस्ट बॉडी एडिट करो, ‘Send’ दबाओ - और रियल रिस्पॉन्स देखो, docs से बाहर निकले बिना। मेथड, पाथ और बॉडी का उदाहरण पहले से जेनरेटेड curl‑स्निपेट से लिया जाता है, इसलिए विजेट openapi.json पर अतिरिक्त रिक्वेस्ट नहीं करता।

सादा बात: अगर तेरा प्रोडक्ट API है, तो डॉक्यूमेंटेशन सिर्फ आँखों से पढ़ने के लिए नहीं, बल्कि एजेंट द्वारा खपत के लिए भी उपयुक्त होना चाहिए। आज‑कल आधी इंटीग्रेशन इस बात से शुरू होती है कि डेवलपर docs का लिंक Claude या Cursor में डालता है और ‘इसे कनेक्ट करो’ कहता है। हमने ऐसा किया है कि अंत में साफ़ टेक्स्ट और मशीन कॉन्ट्रैक्ट मिले, न कि HTML जिसे पार्स करना पड़े।

खुद आज़मा: कोई भी docs पेज खोल, ऊपर दाएँ एक्शन मेन्यू पर क्लिक कर - और ‘Open in Claude’ देख।