Back to all reviewers

Optimize documentation for usability

shadcn-ui/ui
Based on 2 comments
TSX

When creating component documentation, prioritize the developer experience by providing clear, usable examples and configurations. For Storybook components, configure props documentation thoughtfully—rather than removing props like `children` from the table entirely, consider using more specific controls:

Documentation TSX

Reviewer Prompt

When creating component documentation, prioritize the developer experience by providing clear, usable examples and configurations. For Storybook components, configure props documentation thoughtfully—rather than removing props like children from the table entirely, consider using more specific controls:

// Instead of hiding children completely:
children: {
  table: {
    disable: true,
  },
},

// Better approach - disable only the control:
children: {
  control: false,
},

// Or constrain to text when appropriate:
children: {
  control: 'text',
},

Organize documentation in a logical structure that matches user expectations (such as aligning with your public documentation structure) and leverage specialized documentation blocks like ColorPalette and TypeSet for design systems. This makes documentation more intuitive and helps developers quickly find and implement components.

2
Comments Analyzed
TSX
Primary Language
Documentation
Category

Source Discussions