You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Our current HexagonChart component in Storybook lacks detailed descriptions that help users understand the purpose and functionality of different stories. This can be frustrating for users who are not familiar with the component, as they may struggle to understand how to use it effectively.
Describe the solution you'd like
We should enhance the HexagonChart Storybook by utilizing the args parameter to include clear and concise descriptions for each story. These descriptions will provide users with a better understanding of the component’s purpose, how to use it, and what to expect from each variant. This improvement will make the Storybook more user-friendly and accessible, especially for new users or contributors.
Describe alternatives you've considered
Adding documentation outside of Storybook, but this would not be as integrated or contextually helpful as using args within the Storybook itself.
Including descriptions in the form of comments or external documentation, though this may not be as immediately visible to users exploring the Storybook.
Additional context
By enhancing the descriptions directly within Storybook, we can offer a more intuitive and guided experience for users. This approach will also align with modern documentation practices, making it easier for new developers to onboard and contribute to the HexagonChart component. Below is an example of how this can be implemented:
exportdefault{title: 'HexagonChart',component: HexagonChart,args: {data: sampleData,},parameters: {docs: {description: {// we need component: 'HexagonChart component is used to display data in a hexagonal grid. This story demonstrates the default configuration.',},},},};
This issue should help drive the enhancement of the HexagonChart Storybook to improve user experience and usability.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
Our current HexagonChart component in Storybook lacks detailed descriptions that help users understand the purpose and functionality of different stories. This can be frustrating for users who are not familiar with the component, as they may struggle to understand how to use it effectively.
Describe the solution you'd like
We should enhance the HexagonChart Storybook by utilizing the args parameter to include clear and concise descriptions for each story. These descriptions will provide users with a better understanding of the component’s purpose, how to use it, and what to expect from each variant. This improvement will make the Storybook more user-friendly and accessible, especially for new users or contributors.
Describe alternatives you've considered
Additional context
By enhancing the descriptions directly within Storybook, we can offer a more intuitive and guided experience for users. This approach will also align with modern documentation practices, making it easier for new developers to onboard and contribute to the HexagonChart component. Below is an example of how this can be implemented:
This issue should help drive the enhancement of the HexagonChart Storybook to improve user experience and usability.
The text was updated successfully, but these errors were encountered: