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

feat: Add documention for Gap and Margin utility classes #1427

Merged
merged 30 commits into from
Jul 24, 2024

Conversation

VincentSmedinga
Copy link
Contributor

@VincentSmedinga VincentSmedinga commented Jul 19, 2024

Describe the pull request

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

What

This documents the Gap and Margin Bottom utility classes.

Why

So that people know when and how to use them – or even that they exist.

How

It follows the approach of the recently added Visually Hidden docs.

I needed to restore the md value in ams-sizes again, because these gap and margin utilities do need a class name for this size, so I updated the Row and Column stylesheets to skip this value.

By the way, I think we should mark (non-trivial) documentation updates as features from now on. Documentation on how to use things is an important part of our design system and they deserve a place in the change log.

@VincentSmedinga VincentSmedinga requested review from dlnr and alimpens July 19, 2024 22:22
@VincentSmedinga VincentSmedinga force-pushed the feature/DES-847-utility-class-docs branch from a5c1cea to 9ff747f Compare July 22, 2024 15:46
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 22, 2024 15:46 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 22, 2024 15:49 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 22, 2024 15:58 Destroyed
@VincentSmedinga VincentSmedinga changed the title feat: Add documention for gap and margin utility classes feat: Add documention for Gap and Margin utility classes Jul 22, 2024
storybook/src/components/Field/Field.stories.tsx Outdated Show resolved Hide resolved
packages/css/src/common/size.scss Show resolved Hide resolved
packages/css/src/components/margin/README.md Outdated Show resolved Hide resolved
storybook/src/utils/Margin/Margin.stories.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Gap/Gap.docs.mdx Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 23, 2024 14:58 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 23, 2024 21:57 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 23, 2024 22:01 Destroyed
storybook/src/utils/Gap/Gap.stories.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Gap/Gap.stories.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Margin/Margin.stories.tsx Outdated Show resolved Hide resolved
@VincentSmedinga VincentSmedinga requested a review from alimpens July 24, 2024 10:26
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 10:26 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 10:29 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 10:54 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 10:57 Destroyed
Enables Storybook to better render the prop values.
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 11:21 Destroyed
storybook/src/utils/Gap/Gap.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Gap/Gap.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Margin/Margin.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Margin/Margin.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Margin/Margin.tsx Outdated Show resolved Hide resolved
storybook/src/utils/VisuallyHidden/VisuallyHidden.tsx Outdated Show resolved Hide resolved
storybook/src/utils/Gap/Gap.tsx Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 11:34 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 11:47 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 12:18 Destroyed
Co-authored-by: Aram <[email protected]>
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 12:28 Destroyed
@github-actions github-actions bot temporarily deployed to demo-DES-847-utility-class-docs July 24, 2024 12:31 Destroyed
@alimpens alimpens merged commit 6adbd13 into develop Jul 24, 2024
6 checks passed
@alimpens alimpens deleted the feature/DES-847-utility-class-docs branch July 24, 2024 12:35
@github-actions github-actions bot mentioned this pull request Jul 25, 2024
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.

2 participants