website icon indicating copy to clipboard operation
website copied to clipboard

[FEATURE] Add Storybook stories for core UI components

Open sammy200-ui opened this issue 1 week ago • 1 comments

Why do we need this improvement?

The AsyncAPI website uses Storybook for documenting UI components, but many core reusable components currently lack stories. Currently, only 11 components have Storybook stories:

  • Avatar, InputBox, Loader, Heading, Paragraph, Accordion, Button, BlogPostCard, Checkbox, Toggle, Tags

The following actively-used components would benefit from Storybook documentation: Modal , Testimonial , Warning , Remember , Tabs , TextLink

How will this change help?

This makes it harder for new contributors to understand component APIs and for maintainers to ensure visual consistency.

How could it be implemented/designed?

Add comprehensive Storybook stories for each component including:

  1. Default state
  2. Different prop variations (sizes, styles, states)
  3. Interactive controls using argTypes
  4. Proper documentation following existing patterns in Button.stories.tsx

🚧 Breaking changes

Yes

👀 Have you checked for similar open issues?

  • [x] I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

sammy200-ui avatar Dec 16 '25 20:12 sammy200-ui

@hk2166 This work was already claimed and explicitly mentioned in the issue when it was created. Raising a pr and proceeding without coordination or maintainer approval is not appropriate, especially when this has happened multiple times from you as i have observed. Please check existing issues and wait for maintainer confirmation before opening or acting on issues to avoid duplicate work and confusion.

@princerajpoot20 this task was already claimed in the issue. Just flagging to avoid duplicate work.

sammy200-ui avatar Dec 17 '25 14:12 sammy200-ui