docs: improved design system documentation - button #4527
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
Revamped the button documentation to enhance the developer experience. The new docs consolidate all stories in one place, including sample code and provide an interactive props table where users can modify props and see live variations of the button. Done the following changes: 1. Added webiny-admin-storybook-docs command in package.json to generatedocs while skipping the story list in side navigation. 2. Added storybook-docs command to start Storybook in docs-only mode on port 6007. 3. Included button variation examples with code samples. 4. Defined all argTypes (props) in Button.stories.tsx to make them available in the Props table. This improves the discoverability, usability, and interactivity of the button documentation.
removed unused build commands
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.
Changes
Improved button design system documentation
Revamped the button documentation to enhance the developer experience.
The new docs consolidate all stories in one place,
including sample code and provide interactive props
table where users can modify props and see live variations of the button.
Done the following changes:
webiny-admin-storybook-docscommand inpackage.jsonto generate docswhile skipping the story list in the side navigation.
storybook-docscommand to start Storybook in docs-only mode on port 6007.--docsprefix tobuild-storybookto publish only MDX docs (skipping the story list in side navigation) while building the Storybook project that is deployed vianpx chromatic --project-tokencommand and ourChromatic - Storybook Preview GitHub action to Chromatic.
argTypes(props) inButton.stories.tsxto make them available in the Props table.This improves the discoverability, usability, and interactivity of the button documentation.
How Has This Been Tested?
Manually