component-docs

Generate local UI component documentation by specifying the component name and source path to automatically produce Markdown files containing usage examples, props tables, and JSDoc comments. This ensures your component docs stay synchronized with the codebase.

Yes, component documentation generation includes optional Storybook stories to streamline component adoption and testing. It automatically outputs Markdown files with usage examples, props tables, and JSDoc comments alongside these stories.

The best way to keep component props tables and usage examples updated is to generate documentation directly from the source code located in apps/web/src/components or relevant route segments, ensuring Markdown docs and JSDoc comments match the implementation.

Yes, component documentation generation applies to components located under apps/web/src/components as well as relevant route segments. You can target local UI components by specifying their name and source path to produce Markdown docs.

Yes, generated component documentation provides up-to-date references to official docs for third-party components like HeroUI v3 when applicable, alongside the generated Markdown usage examples and props tables for your local components.