Repository navigation
Carbon skill for Claude — offline, auto-synced Carbon docs as an AI coding skill #22482
iamursky
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Sharing a side project: a Claude skill for the Carbon Design System.
A "skill" is a self-contained bundle of docs + guidance that an AI coding agent (Claude / Claude Code) loads on demand, so it answers from the real Carbon docs instead of guessing or hallucinating outdated APIs. This one packages Carbon's own in-repo documentation into that format.
What it is
@carbon/reactand@carbon/web-components— plus the foundational elements.carbon-design-system/carbonmonorepo: the colocated Storybook MDX (component usage), the per-package READMEs (colors, themes, grid, layout, type, motion, icons, pictograms), and selecteddocs/guides (Sass, accessibility, IBM Plex, feature flags, v11 migration).> Source:link back to its file on GitHub, and component pages link to Source code · Usage guidelines · Accessibility.What it helps with
@carbon/styles(@use, Dart Sass, thecdsprefix)<Theme>,$themewith-config), the 2x Grid, icons & tokens, feature flags / preview code, and the v10 → v11 migrationHow it stays current
The references are generated, not hand-written. A small stdlib-only Python converter turns the Storybook MDX into clean Markdown, and a GitHub Action re-runs it daily — it checks the upstream monorepo HEAD and only opens a sync PR when Carbon's docs actually change. A guard fails the build if upstream introduces a Storybook component the converter doesn't handle yet, so the bundle never silently drifts.
Heads-up on fidelity
Live Storybook
<Canvas>demos and the auto-generated<ArgTypes>prop tables can't be rendered statically, so those are replaced with a pointer to the live Storybook + the Source code link. Everything else — prose, code examples, CDN snippets — is preserved.Try it
👉 Repo: https://github.com/iamursky/carbon-skill
All reactions