f5xc-docs-tools

f5xc-docs-tools प्लगइन f5-sales-demo दस्तावेज़ीकरण पाइपलाइन के लिए MDX कंटेंट फ़ाइलों को सत्यापित करता है। यह CI तक पहुँचने से पहले सामान्य बिल्ड-तोड़ने वाली समस्याओं को पकड़ता है, जिनमें bare JSX अक्षर, अमान्य इम्पोर्ट, टूटे हुए इमेज संदर्भ और अधूरा frontmatter शामिल हैं।

v1.1.2 Productivity

इंस्टॉलेशन

/plugin install f5xc-docs-tools@f5-sales-demo-marketplace

कौशल

mdx-content-reviewer

यह कौशल स्वचालित रूप से सक्रिय होता है जब Claude पता लगाता है कि आप f5-sales-demo कंटेंट रिपॉजिटरी में MDX फ़ाइलों के साथ काम कर रहे हैं। यह सात सत्यापन जाँचें करता है:

Frontmatter सत्यापन

title और sidebar.order जैसे आवश्यक फ़ील्ड की जाँच करता है। Splash पृष्ठों में hero फ़ील्ड और template: splash शामिल होने चाहिए।

MDX सिंटैक्स संबंधी समस्याएँ

bare < अक्षरों और अनएस्केप्ड \{ \} ब्रेसेज़ का पता लगाता है जो MDX पार्सिंग को तोड़ते हैं।

इम्पोर्ट सत्यापन

Starlight बिल्ट-इन और f5-sales-demo थीम घटकों की अनुमति सूची के विरुद्ध इम्पोर्ट को सत्यापित करता है।

घटक विशेषताएँ

Screenshot, Aside, Code, LinkCard, Card और Badge जैसे घटकों के लिए आवश्यक props की जाँच करता है।

इमेज संदर्भ

यह सत्यापित करता है कि संदर्भित इमेज docs/images/ डायरेक्टरी में मौजूद हैं।

संरचना जाँच

यह सुनिश्चित करता है कि docs/index.mdx मौजूद है और इमेज डायरेक्टरी में कोई अनावश्यक MDX फ़ाइलें नहीं हैं।

एक्सपोर्ट और कोड ब्लॉक

यह सत्यापित करता है कि Code घटक के code props में उपयोग किए गए चर में मिलान करने वाले एक्सपोर्ट हैं।

स्कोपिंग व्यवहार

कौशल अपनी समीक्षा को बुद्धिमानी से सीमित करता है:

यदि docs/**/*.mdx फ़ाइलों में अनकमिटेड या स्टेज्ड परिवर्तन हैं, तो केवल उन्हीं फ़ाइलों की समीक्षा की जाती है
अन्यथा, सभी docs/**/*.mdx फ़ाइलों की समीक्षा की जाती है

आउटपुट प्रारूप

निष्कर्षों को गंभीरता के अनुसार समूहीकृत किया जाता है:

ERROR — बिल्ड को तोड़ेगा; मर्ज करने से पहले ठीक करना आवश्यक है
WARNING — संभावित समस्याएँ जिन्हें संबोधित किया जाना चाहिए
INFO — सुझाव और सर्वोत्तम अभ्यास

प्रत्येक निष्कर्ष में फ़ाइल पथ, पंक्ति संख्या और समस्या का विवरण शामिल होता है।

कमांड

/review-mdx

/f5xc-docs-tools:review-mdx [path-or-glob]

माँग पर mdx-content-reviewer कौशल चलाता है।

तर्क:

तर्क	आवश्यक	विवरण
`path-or-glob`	नहीं	समीक्षा को सीमित करने के लिए फ़ाइल पथ या glob पैटर्न। डिफ़ॉल्ट रूप से सभी `docs/*/.mdx` फ़ाइलें।

उदाहरण:

# docs/ में सभी MDX फ़ाइलों की समीक्षा करें
/f5xc-docs-tools:review-mdx

# किसी विशिष्ट फ़ाइल की समीक्षा करें
/f5xc-docs-tools:review-mdx docs/getting-started.mdx

# glob से मिलान करने वाली फ़ाइलों की समीक्षा करें
/f5xc-docs-tools:review-mdx docs/guides/*.mdx

आउटपुट: अंत में एक सारांश पंक्ति समीक्षा की गई कुल फ़ाइलों और गंभीरता के अनुसार निष्कर्षों की संख्या की रिपोर्ट करती है।

अनुमत इम्पोर्ट

प्लगइन इन स्रोतों के विरुद्ध इम्पोर्ट को सत्यापित करता है:

Starlight बिल्ट-इन घटक (@astrojs/starlight/components):

Aside Badge Card CardGrid Code FileTree Icon LinkCard Steps TabItem Tabs

f5-sales-demo थीम घटक (@f5-sales-demo/docs-theme/components/):

Banner Icon LinkCard Screenshot

घटक त्वरित संदर्भ

घटक	आवश्यक Props	वैकल्पिक Props
Screenshot	`alt` + कम से कम एक `light` या `dark`	—
Aside	`type`	`title`
Code	`code`, `lang`	`title`, `frame`, `mark`, `ins`, `del`
LinkCard (थीम)	`title`, `href`	`description`, `icon`
Card	`title`	`icon`
Badge	`text`	`variant`
Steps	—	—
Tabs / TabItem	TabItem: `label`	—
CardGrid	—	—
FileTree	—	—

MDX संबंधी समस्याएँ

प्लगइन द्वारा पकड़ी जाने वाली सामान्य समस्याएँ:

समस्या	कठिनाई	समाधान
Bare `<`	MDX इसे JSX टैग के रूप में व्याख्यायित करता है	`&lt;`, इनलाइन कोड का उपयोग करें, या पुनः लिखें
अनएस्केप्ड `\{` `\}`	MDX इसे JSX एक्सप्रेशन मानता है	इनलाइन कोड, `\` से एस्केप, या कोड ब्लॉक का उपयोग करें
फ़ाइलनामों में ब्रेसेज़	Astro फ़ाइल को प्रोसेस नहीं कर सकता	`.mdx` फ़ाइलनामों में कभी `\{` या `\}` का उपयोग न करें