fix(docs): adjust tokens table doc #705
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabrielduete
changed the title
|
|
gabrielduete
requested review from
a team,
dyhalmeida,
mauriciomutte,
3rdepaula and
jowjow22
and removed request for
a team
dyhalmeida
approved these changes
Feb 14, 2025
anabrook
approved these changes
Feb 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Infos
Task
What is being delivered?
This pull request includes several changes to improve the readability and maintainability of the documentation by replacing static HTML tables with a reusable
Tablecomponent and fixing some minor issues. The most important changes include updating multiple story files to use the newTablecomponent and making minor formatting adjustments.Use of Table Component:
packages/tokens/stories/components/Table.jsx: Created a newTablecomponent to replace static HTML tables across the documentation. Ref: How to generate table in storybook .mdx files storybookjs/storybook#22613 (comment)packages/tokens/stories/2_Spacings.mdx: Replaced the static HTML table with the newTablecomponent to display spacing variables.packages/tokens/stories/3_Typography.mdx: Updated the file to use theTablecomponent for displaying typography variables and values. [1] [2] [3]packages/tokens/stories/4_Screens.mdx: Integrated theTablecomponent to show screen size variables and breakpoints.packages/tokens/stories/5_Grid.mdx: Modified the file to utilize theTablecomponent for grid-related variables and patterns.packages/tokens/stories/6_Misc.mdx: Converted the static HTML tables to use theTablecomponent for miscellaneous tokens. [1] [2] [3]Minor Adjustments:
packages/tokens/stories/3_Typography.mdx: Changed double quotes to single quotes for consistency insampleTextand other text fields.packages/tokens/stories/7_Elevation.mdx: Updated the file to use theTablecomponent for elevation variables and adjusted the elevation box elements to use single quotes. [1] [2]packages/tokens/stories/components/Box.jsx: Added an ESLint directive to ignore unused variables.What impacts?
Stories
Reversal plan
Revert the PR
Evidences