component-docs

Name: component-docs
Availability: InStock
Author: Coinbase

Create and update CDS component documentation on the docsite.

493|101|Updated Nov 8, 2024

Search Tags:#documentation #design system #component #content creation #developer guide

Ready to run

npx skills add https://github.com/coinbase/cds --skill component-docs-coinbase

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: component-docs
Source: https://github.com/coinbase/cds/tree/main/.claude/skills/component-docs
Command: npx skills add https://github.com/coinbase/cds --skill component-docs-coinbase

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of creating and updating documentation for components within the Coinbase Design System (CDS), ensuring consistency and discoverability.

Core Features & Use Cases

Component Documentation Generation: Guides users through the steps of adding new component documentation or updating existing ones.
Consistency Enforcement: Provides templates and best practices to maintain a uniform documentation style across all components.
Use Case: A developer needs to add documentation for a new UserProfileCard component. They can use this Skill to follow the established process, ensuring all necessary files (metadata, examples, props tables) are created correctly.

Quick Start

Use the component-docs skill to create documentation for the Button component.

Frequently Asked Questions about component-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create documentation for a new design system component?▼

Generating component documentation requires checking existing files, researching best practices, and setting up necessary structures like metadata and props tables to ensure consistency and discoverability.

What is the best way to ensure consistent documentation across UI components?▼

Consistent UI component documentation is maintained by referencing existing components and files, applying best practice templates, and following a guided process for updating the docsite to enforce a uniform style.

How do I update existing component documentation for a design system?▼

Updating existing component documentation involves checking current files on the docsite, verifying component availability, and referencing established structures to maintain accuracy and consistency across updates.

What files do I need to set up when adding a new component to a docsite?▼

Adding a new component to a docsite requires setting up necessary files and structures including metadata, examples, and props tables to ensure comprehensive and discoverable documentation.

Can I use existing component files as a reference for writing new developer guides?▼

Existing component files can be used as references when writing developer guides, allowing you to mirror established documentation structures and maintain style consistency across the design system.