f5xc-docs-tools

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

v1.1.2 उत्पादकता

इंस्टॉलेशन

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

स्किल्स

mdx-content-reviewer

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

फ्रंटमैटर सत्यापन

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

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

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

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

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

कंपोनेंट एट्रिब्यूट्स

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

इमेज रेफरेंस

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

संरचना जाँच

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

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

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

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

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

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

आउटपुट फॉर्मेट

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

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

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

कमांड्स

/review-mdx

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

mdx-content-reviewer स्किल को माँग पर चलाता है।

आर्ग्यूमेंट्स:

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

उदाहरण:

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

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

# ग्लोब से मिलान करने वाली फ़ाइलों की समीक्षा करें
/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

कंपोनेंट त्वरित संदर्भ

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

MDX समस्याएँ

सामान्य समस्याएँ जिन्हें प्लगइन पकड़ता है:

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