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 headings and guidelines throughout documentation #1565

Merged
merged 6 commits into from
Sep 4, 2024

Conversation

VincentSmedinga
Copy link
Contributor

Describe the pull request

What

  • Uses sentence case for headings, instead of title case and documents this in Storybook contribution guidelines
  • Changes ‘How to use’ and ‘Usage’ to ‘Guidelines’ for consistency, where appropriate
  • Removes ‘When to use’ and ‘What to avoid’ for now – this distinction will return but more clearly and consistently
  • Marks up guidelines as a list everywhere
  • Move some instances of text from the ‘Examples’ section to ‘Guidelines’
  • Fixes heading levels where necessary
  • Increases consistency in Story names and headings
  • Improves consistency for examples of the as prop

Why

The main goal was to stop using ‘Title Case’ in headings, even though it introduces a difference with the table of contents that Storybook generates, and to put the ‘Examples’ heading in the correct place for all components.

How

Manually :)

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

@VincentSmedinga VincentSmedinga changed the title chore: Improve headings on all documentation pages chore: Improve headings and guidelines on all documentation pages Sep 3, 2024
@VincentSmedinga VincentSmedinga changed the title chore: Improve headings and guidelines on all documentation pages chore: Improve headings and guidelines throughout documentation Sep 3, 2024
dlnr
dlnr previously approved these changes Sep 3, 2024
Copy link
Contributor

@dlnr dlnr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotta love consistency.

storybook/src/components/Accordion/Accordion.docs.mdx Outdated Show resolved Hide resolved
storybook/src/components/Accordion/Accordion.docs.mdx Outdated Show resolved Hide resolved
storybook/src/components/Avatar/Avatar.docs.mdx Outdated Show resolved Hide resolved
storybook/src/components/Dialog/Dialog.docs.mdx Outdated Show resolved Hide resolved
storybook/src/components/Field/Field.docs.mdx Show resolved Hide resolved
storybook/src/components/Overlap/Overlap.docs.mdx Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-sentence-case-for-headings September 4, 2024 11:22 Destroyed
@github-actions github-actions bot temporarily deployed to demo-sentence-case-for-headings September 4, 2024 11:57 Destroyed
@github-actions github-actions bot temporarily deployed to demo-sentence-case-for-headings September 4, 2024 12:09 Destroyed
@alimpens alimpens merged commit d967045 into develop Sep 4, 2024
6 checks passed
@alimpens alimpens deleted the chore/sentence-case-for-headings branch September 4, 2024 12:26
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.

3 participants