Automated summary
Generates markdown documentation for a new component by following the existing docs folder conventions and the same-named story implementation.
Strengths
- Forces reuse of conventions already present in the docs folder (e.g. button.md, accordion.md)
- Grounds the write-up in a real implementation under crates/story/src/stories
- Specifies a clear expected structure: description, props/API, usage examples, visual examples
- Includes docs.rs links for API references where applicable
Limitations
- Output quality depends on how consistent the existing docs used as templates are
- Assumes a story with the same name already exists in crates/story/src/stories
- Describes no verification, build, or lint step for the generated documentation
Use when a new component already has a story and you want its documentation written in line with the docs folder conventions.
Avoid when the component has no matching story, or when the docs must follow an external spec that is not reflected in the docs folder.
Security analysis
SafeThe skill only provides documentation-generation guidance and does not instruct any destructive, network, exfiltration, or tool-execution behavior. No allowed tools are declared, so there is no meaningful execution risk.
No concerns found
How this analysis is madeExamples
Write documentation for the new Tooltip component, following the style of the existing files in the docs folder such as button.md and accordion.md.Generate component docs for Slider based on its story implementation in crates/story/src/stories, including props, usage, and examples.Update the docs for the Dialog component to add a props/API section with docs.rs links, matching the docs folder patterns.name: generate-component-documentation description: Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.
Instructions
When generating documentation for a new component:
- Follow existing patterns: Use the documentation styles found in the
docsfolder (examples:button.md,accordion.md, etc.) - Reference implementations: Base the documentation on the same-named story implementation in
crates/story/src/stories - API references: Use markdown
codeblocks with links to docs.rs for component API references when applicable
Examples
The generated documentation should include:
- Component description and purpose
- Props/API documentation
- Usage examples
- Visual examples (if applicable)
From the file to a first result
The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.
View the source and supporting filesThis download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.
1. Download the file
Download SKILL.mdFrom the root of a test project, save the file as .skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.
Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.
mkdir -p '.skill-downloads/generate-component-documentation-ms2s7cfy' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/generate-component-documentation-ms2s7cfy/download' --output '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md.part' && mv '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md.part' '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md'2. Check prerequisites
Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.
No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.
The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.
3. Load the skill
After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.
Claude Code
test -f '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && test -s '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/generate-component-documentation' && cp -R '.skill-downloads/generate-component-documentation-ms2s7cfy' '.claude/skills/generate-component-documentation'Cursor
test -f '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && test -s '.skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/generate-component-documentation' && cp -R '.skill-downloads/generate-component-documentation-ms2s7cfy' '.cursor/skills/generate-component-documentation'OpenSkills
OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.
Official OpenSkills installationopenskills install './.skill-downloads/generate-component-documentation-ms2s7cfy'openskills read 'generate-component-documentation-ms2s7cfy'Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.
For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.
openskills syncManual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.
4. Try a first task
Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:
Read .skill-downloads/generate-component-documentation-ms2s7cfy/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.
Supabase Docs Authoring
Documentation
Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.
Create Architecture Decision Record
Documentation
Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.
Plan update with deep research
Documentation
Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.