DS-451 skill.md to convert to mdx#4487
Draft
cmcinnis-coveo wants to merge 22 commits into
Draft
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
|
Live demos of your latest successful build available here: |
|
@cmcinnis-coveo, before approving, I'd like to see a test run (conversions) using the skills. |
Contributor
Author
@ksampsoncoveo Sure thing--I'm reworking some things right now in the skills and will include a demo before I mark it as ready for review. Thank you! |
4e64d8c to
797b4dd
Compare
Contributor
Release PreviewThis PR would not change any package versions if it were merged and released from |
Contributor
|
Live demo of your latest successful build available here: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request introduces two new Storybook-related skills for working with Plasma component documentation, along with detailed guidance and reference files for each.
converting-md-to-storybook-mdx, provides a step-by-step process for converting LLM-facing Markdown files into Storybook-ready MDX docs-only pages, including all formatting, placement, and escaping rules.storybook-component-docs, outlines how to rewrite terse, machine-facing component docs into clear, human-readable usage guidelines, with strict rules for structure, style, and content completeness. Both skills include comprehensive instructions, checklists, and reference files to ensure consistency and quality.Proposed changes
New skills:
.github/skills/converting-md-to-storybook-mdx/SKILL.md, a skill for converting component.mdfiles frompackages/llms/src/components/into MDX docs-only pages for the Plasma Storybook, with detailed process steps, formatting rules, and validation checklist..github/skills/storybook-component-docs/SKILL.md, a skill for rewriting LLM-facing component docs into clear, human-readable usage guidelines for Storybook, including a page template, section-by-section rewrite rules, and completeness checklist.Reference and formatting:
.github/skills/converting-md-to-storybook-mdx/references/mdx-patterns.md, a reference covering required MDX structure, JSX escaping rules, handling of special links, GFM support, and troubleshooting for MDX docs..github/skills/storybook-component-docs/references/expected-format.md, specifying the exact required format for the Content guidance section, including structure, subheading and bullet rules, and minimum coverage requirements.Demo
PR - results for "A" components
(^ includes demo links)