Replace auto-docs with a free-form MDX documentation page #73
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
✅ Deploy Preview for cfpb-design-stories ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Storybook's autodocs pages lack a lot of the information about our components (rendered states, guidelines, a11y tips). To show how MDX docs work, I created an overview page for the Checkbox component and copied over the content from https://cfpb.github.io/design-system/components/checkboxes MDX supports any flavor of markdown so we can add whatever we'd like to the docs pages if we decide to go this route. Closes #68
Functionally I think it could replace the DS site, but the Storybook content does still feel quite dry by comparison. Maybe SB just needs some additional styling? |
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.
Storybook's autodocs pages lack a lot of the information about our components (rendered states, guidelines, a11y tips). To show how MDX docs work, I created an overview page for the Checkbox component and copied over the content from the DS checkbox page.
MDX = MarkDown JSX and supports any flavor of markdown, including raw HTML.
Closes #68
See https://storybook.js.org/docs/react/writing-docs/mdx
See https://storybook.js.org/docs/react/writing-docs/doc-blocks
How to test this PR
Notes
Couple things to mull over:
View codebutton), could we retire the DS website? Or is the barebones nature of Storybook too ugly when compared to the DS website?