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

Update typography docs and Storybook theming #771

Merged
merged 6 commits into from
Nov 21, 2023

Conversation

VincentSmedinga
Copy link
Contributor

@VincentSmedinga VincentSmedinga commented Nov 20, 2023

This structures our typography documentation:

  • Reorders and groups the sections
  • Uses the Typeset doc block – with static font sizes or it will render long clamp labels
  • Reformulates some of the guidelines
  • Removes the maximum sentence length of 80 characters
  • Mentions the font license and form

It also improves readability of our docs by enlarging the tiny prose text, applying our own font and increasing whitespace. There appears to be no better way to achieve this than to bluntly override CSS (see issues). Also textSize in themeConfig has no effect. Suggestions welcome, I do think we need the end result.

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.

Documentation looks great with the TypeSet component, great find!

storybook/storybook-docs/src/grid.stories.mdx Outdated Show resolved Hide resolved
proprietary/assets/font/index.css Show resolved Hide resolved
storybook/storybook-docs/config/preview-head.html Outdated Show resolved Hide resolved
storybook/storybook-docs/src/typography.stories.mdx Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-typography-doc-blocks November 20, 2023 23:08 Destroyed
@github-actions github-actions bot temporarily deployed to demo-typography-doc-blocks November 21, 2023 08:49 Destroyed
@github-actions github-actions bot temporarily deployed to demo-typography-doc-blocks November 21, 2023 09:01 Destroyed
@VincentSmedinga VincentSmedinga merged commit 415afce into develop Nov 21, 2023
3 checks passed
@VincentSmedinga VincentSmedinga deleted the task/typography-doc-blocks branch November 21, 2023 11:59
Copy link
Contributor Author

@VincentSmedinga VincentSmedinga left a comment

Choose a reason for hiding this comment

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

@alimpens I’ve applied your feedback to #803.

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