Skip to content

DS-451 skill.md to convert to mdx#4487

Draft
cmcinnis-coveo wants to merge 22 commits into
masterfrom
DS-451-component-doc-skill
Draft

DS-451 skill.md to convert to mdx#4487
cmcinnis-coveo wants to merge 22 commits into
masterfrom
DS-451-component-doc-skill

Conversation

@cmcinnis-coveo

@cmcinnis-coveo cmcinnis-coveo commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

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.

  1. 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.
  2. 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:

  • Added .github/skills/converting-md-to-storybook-mdx/SKILL.md, a skill for converting component .md files from packages/llms/src/components/ into MDX docs-only pages for the Plasma Storybook, with detailed process steps, formatting rules, and validation checklist.
  • Added .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:

  • Added .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.
  • Added .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)

@svcsnykcoveo

svcsnykcoveo commented Jun 26, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

Copy link
Copy Markdown
Contributor

Live demos of your latest successful build available here:

Comment thread .claude/skills/converting-md-to-storybook-mdx/references/mdx-patterns.md Outdated
Comment thread .claude/skills/converting-md-to-storybook-mdx/scripts/convert.mjs Outdated
Comment thread .claude/skills/converting-md-to-storybook-mdx/SKILL.md Outdated
Comment thread packages/storybook/src/call-to-action/ActionIcon.mdx Outdated
@cmcinnis-coveo cmcinnis-coveo requested a review from gdostie July 2, 2026 14:42
@ksampsoncoveo

Copy link
Copy Markdown

@cmcinnis-coveo, before approving, I'd like to see a test run (conversions) using the skills.

@cmcinnis-coveo

cmcinnis-coveo commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

@cmcinnis-coveo, before approving, I'd like to see a test run (conversions) using the skills.

@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!

@cmcinnis-coveo cmcinnis-coveo force-pushed the DS-451-component-doc-skill branch from 4e64d8c to 797b4dd Compare July 8, 2026 14:53
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Release Preview

This PR would not change any package versions if it were merged and released from master.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Live demo of your latest successful build available here:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants