Components: Consolidate and add docs to Storybook #50226
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
chad1008
added
[Package] Components
chad1008
force-pushed
the
components-consolidate-docs
branch
from
4fea2f1 to
60073a1
Compare
|
Size Change: +1.72 kB (0%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
mirka
approved these changes
May 3, 2023
There was a problem hiding this comment.
Nice, love this!
While reviewing I had some minor suggestions that I couldn't make directly on this PR, so I branched off and made them, if that's ok. The main thing I'd like to suggest is to move the docs to the Components section in the Storybook, because our Storybook is starting to get pretty multi-tenant (block-editor, edit-site, etc).
What do you think? Feel free to tweak or cherry pick from my branch as you see fit.
|
|
||
| <Meta title="Docs/Contributing Guidelines" /> | ||
|
|
||
| <Contributing /> |
|
That all makes sense, thanks for sharing the changes @mirka! I noticed that when moving the README into the |
Yes, I guess because "readme" as a naming convention is more for when you're browsing files, not when browsing online documentation. No strong opinion though! |
|
Thanks again @mirka. Cherry-picked and merging ✅ |
3 tasks
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.
What?
Consolidate multiple instances of key docs (
README.mdandCONTRIBUTING.md) and configure Storybook to display them.Why?
Up until now we've had two copies of both
READMEandCONTRIBUTING: one in the package root, and another in thesrcdirectory. Consolidating these makes things clearer for contributors and surfacing them in Storybook makes them more visible and easier to access. Also because it was fun.How?
The two copies of
CONTRIBUTINGwere identical, so the duplicate was just deleted.The contents of the two
READMEfiles were different, with the root copy focusing on detailed instructions for different aspects of a contribution, while thesrccopy focused more on the workflow of introducing a new component. I've combined all of this into a single file with one small change. Thesrccopy's workflow for new components included a step to create a Figma component, which I don't believe we're still doing, so I took that step out. It's easy enough to add back in if it's still relevan.Finally to render both of these docs in Storybook, I enabled the
transcludeMarkdownconfig setting, which allows mdx files to import.mdfiles and render their contents as a component. I then added two new.mdxfiles, one to import each of the desired docs.Testing Instructions
Look over both affected docs to make sure the relevant info has been carried over. Check that the both render nicely in Storybook.