document-component
Import or document a prototype-system component with a page and live examples.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 161
- Forks
- 25
01 前言 Front Matter
- name
- document-component
- description
- Import or document a prototype-system component with a page and live examples.
03 SKILL.md 正文
Scope and input
Read the system authoring context and component contract.
Identify the target system and component. Preserve existing source, examples, and documentation. Follow the user's library rather than assuming every system uses shadcn.
Import when needed
For shadcn components, read the target system's components.json and follow Curate from libraries. Generate selected components through Manual staging. A --path override alone does not isolate theme, helper, or dependency writes. Do not run upstream initialization or preset application in the Studio checkout.
Apply the system's theme and portal requirements. Skip import when documenting an existing component.
Create and complete documentation
- Run
pnpm component-docs <system> <component>. The command creates missing files and preserves existing files. - Fill the page's title, description, and
## When to usesection. Add other guidance only when useful. For generated components, use a shortsourcefrontmatter sentence naming the library, CLI version, and preset, with thedocsURL alongside it. The compact Source block credits the libraries whosecomponentslist includes this component, so add the component's slug to the list of each library it actually comes from, and to no other. It preserves the specific upstream component docs link. Label the generator as shadcn CLI; do not infer missing versions or presets. Keep detailed adaptations in the system's setup record. - Add representative examples covering meaningful variants and states. Replace unfinished required-prop placeholders.
- Keep examples unwrapped. The platform supplies the theme frame.
The system contract defines file names, exports, and documentation validation. Do not maintain a second schema here.
Completion
Run pnpm build. Inspect /systems/<system-id>/components/<component> using the system's permanent ID, and review examples in supported color modes.
Report completed files and any missing component behavior or source material. Do not claim completion while examples contain placeholders.
04 同仓库更多 Skills
setup-contributor
Register someone joining an existing studio and verify local access. Use configure-studio for a new studio.
manage-modules
Create, install, enable, disable, or remove modules; create, rename, archive, restore, or delete systems through the Studio CLI.
maintain-documentation
Author or audit READMEs, context, and task skills for the platform, modules, and systems; coordinate human Manual updates.
configure-studio
Configure a running studio for the first time, update requested studio settings, or update the studio to a newer Design Studio release. Use setup-contributor for someone joining; installation has its own workflow.
check-design-system
Audit a Design Studio surface against its applicable design system and report findings for human review before any fixes. Use for an explicit design-system review of Studio UI, prototypes, or system previews.
use-__ID__
Use __LABEL__ in Design Studio when the capability is enabled.