Storybook Component Documentation
CheckedHelps with Storybook, components, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add thebushidocollective/han --skill storybook-component-documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
thebushidocollective
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned thebushidocollective/han at 19caa51d5f.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 19caa51d5f
- Scanned
- 1 file, 520 lines
About this skill
What it does
This skill assists in creating comprehensive component documentation within Storybook projects. It leverages Storybook's autodocs feature, MDX pages for custom documentation, and JSDoc comments to automatically generate and enrich documentation for UI components. The goal is to streamline the documentation process as part of writing and content creation workflows.
When to use it
- When building a component library using Storybook.
- To automate the generation of documentation from existing Storybook stories.
- For creating custom, detailed documentation pages with full control over content and formatting.
- When needing to document component props and their types for developer reference.
Key capabilities
- Autodocs: Automatically generates documentation pages based on story metadata.
- MDX Documentation: Allows creation of custom documentation pages using MDX syntax.
- JSDoc Comments: Enables extraction of prop information from JSDoc comments within component code.
- Story Descriptions: Supports adding descriptions to individual Storybook stories for more context.
Example prompts
- "Generate autodocs for the Button component."
- "Create an MDX page documenting the Tooltip component's features and accessibility considerations."
- "Extract JSDoc comments from the Card component's code to document its props."
Tips & gotchas
- Ensure the
autodocstag is included in your Storybook story metadata to enable automatic documentation generation. - Use clear and concise descriptions for components, stories, and individual props to improve readability and understanding.
- This skill focuses on component documentation within a Storybook environment; it does not handle general writing or content creation tasks outside of this context.