मुख्य कंटेंट तक स्किप करें

सामग्री शैली मार्गदर्शिका

सभी लेवल

संगति ही वह चीज़ है जो किसी संदर्भ को भरोसेमंद बनाती है। इनका पालन करें और आपका PR समीक्षा से आसानी से पार हो जाएगा।

लहजा​

  • स्पष्ट और सीधा। छोटे वाक्य। मुख्य बात से शुरुआत करें।
  • मित्रवत, कभी दिखावटी नहीं। "आज की तेज़-रफ़्तार दुनिया में" को काट दें। पाठक के समय का सम्मान करें।
  • राय रखें, फिर ईमानदार रहें। पहले एक अनुशंसित तरीका दें, फिर विकल्पों और समझौतों का उल्लेख करें।
  • सिद्धांत से अधिक उदाहरण। कोई स्निपेट या ठोस उदाहरण दिखाएँ; सिर्फ़ वर्णन न करें।
  • अमेरिकी अंग्रेज़ी।

किसी पृष्ठ की संरचना​

---
sidebar_position: 2
title: "Your Page Title"
description: "One sentence for search and previews."
---

<LevelBadge level="beginner" />

A one or two sentence intro that states what the reader will get.

## Sections with ## headings
...

## Next
- 2–4 links to related pages
  • लेवल बैज से शुरुआत करें (beginner | intermediate | advanced | all)। कॉम्पोनेन्ट वैश्विक हैं — उन्हें इम्पोर्ट न करें।
  • 2–4 आंतरिक लिंक की "Next" / "Related" सूची के साथ समाप्त करें।
  • ज़ोर देने के लिए एडमोनिशन (:::tip, :::warning, :::note, :::info) का उपयोग करें, संयम से।

दो कठोर नियम​

:::warning गैर-समझौतावादी

  1. परिवर्तनशील तथ्यों के लिए स्रोत उद्धृत करें। मॉडल नाम, कीमतें, सीमाएँ, सटीक फ़्लैग, बीटा फ़ीचर्स → आधिकारिक स्रोत लिंक करें और <VerifyNote lastVerified="YYYY-MM-DD" source="…"> जोड़ें। मॉडल तथ्यों को कभी हार्ड-कोड न करें — मॉडल तालिका से लिंक करें। विवरण: तथ्य सत्यापन।
  2. गढ़ें नहीं। कोई आविष्कृत आँकड़े, उद्धरण, API, या फ़ीचर नहीं। अगर अनिश्चित हैं, तो ऐसा कहें या [verify] से चिह्नित करें। :::

राय बनाम आधिकारिक​

  • हम राय रखते हैं — यही मूल्य है। अनुशंसा करें, सिर्फ़ गिनाएँ नहीं।
  • लेकिन आधिकारिक दस्तावेज़ सत्य का स्रोत हैं। उन्हें मानें, उनसे लिंक करें, और कभी चुपचाप उनका खंडन न करें।

MDX की पेचीदगियाँ​

  • गद्य में कर्ली ब्रेसेस {like this} को MDX द्वारा कोड के रूप में पार्स किया जाता है — उन्हें बैकटिक्स या कोड फ़ेंस में रखें, या उदाहरणों में [brackets] का उपयोग करें।
  • स्थानीय रूप से परीक्षण करें: npm run build पास होना चाहिए (यह टूटे हुए लिंक पर विफल हो जाता है)।

आगे​