Document layout in Storybook #67628
Document layout in Storybook #67628
Conversation
jameskoster
added
Storybook
|
Flaky tests detected in 03eef73. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12180031472
|
There was a problem hiding this comment.
Not a blocker, but how much do you anticipate the static images needing to be updated throughout the life of this page?
If we do anticipate updates, it may be more maintainable to render the visuals with code (i.e. divs with CSS styles) or by Figma embed. Otherwise the person wanting to update the images would need to track you down for the source files 😄
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Related to that, I recall early in the life of this project that we added a lot of images for documentation, which caused trouble for contributors having to pull down big PNG files in multiple versions. I wonder how we can avoid that happening again. |
|
|
||
| <img src={ areas } alt="Area definition diagram" width="100%" /> | ||
|
|
||
| 1. **Sidebar** – Primary admin navigation UI including notifications and access to Command Palette. Always positioned on the left of the page (assuming LTR locale). |
There was a problem hiding this comment.
Perhaps use "left-to-right language" or "left-to-right locale" to avoid the acronym?
They're SVGs, so they effectively are the source files. Unless I'm missing a beat? Edit: They also exist in the WPDS source file, so all members of the design team should have access, or be able to easily get access. |
Fair! Let's go with this and we can always revisit if we encounter maintenance issues. |
|
@mirka do you know if it's okay to merge this? I'm seeing some failing checks but they seem optional/unrelated. |
|
@jameskoster Looks good to me 👍 |
Co-authored-by: jameskoster <[email protected]> Co-authored-by: mirka <[email protected]> Co-authored-by: juanbuis <[email protected]> Co-authored-by: jasmussen <[email protected]>
What?
Replicates the documentation on Layout we find in Figma on Storybook.
Why?
Continues the expansion of foundation documentation.
Testing Instructions
npm run storybook:devNow would be a good moment to review this documentation.
In future we can expand this to include more detail. For instance we might describe compositions for section headers, layout grids, and more.