Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance HexagonChart Storybook with Descriptive Args for Improved UX #32

Open
jukangpark opened this issue Aug 6, 2024 · 0 comments
Open

Comments

@jukangpark
Copy link
Collaborator

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:

export default {
  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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant