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

chore: Improve docs for heading level in Accordion #1799

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

VincentSmedinga
Copy link
Contributor

Describe the pull request

Thank you for contributing to the project!
Please use this template to help us handle your PR smoothly.

What

  • Uses h3 instead of h1 by default in Accordion examples
  • Hides the undefined option for headingLevel in the Controls

Why

  • Heading level 1 was confusing. One user didn’t realize they could change that level. An Accordion will not use level 1 headings very often – 3 seems like a good default.

How

  • Improved Storybook config
  • Added a guideline

Checklist

Before submitting your pull request, please ensure you have done the following. Check each checkmark if you have done so or if it wasn't necessary:

  • Add or update unit tests
  • Add or update documentation
  • Add or update stories
  • Add or update exports in index.* files
  • Start the PR title with a Conventional Commit prefix, as explained here.

Additional notes

  • None

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

Successfully merging this pull request may close these issues.

1 participant