Open auareyou opened 1 week ago
https://developer.wordpress.org/block-editor/reference-guides/components/button/
This component is fully documented and it just needs editing and updated visual examples.
https://developer.wordpress.org/block-editor/reference-guides/components/modal/
The documentation is also pretty complete, could be another good candidate.
Just to clarify, what does the end result look like? I'm curious about the roles each channel plays:
My understanding is that the readme's and developer.wp are connected, but both seem inferior compared with Storybook by virtue of the control panel/live preview.
Should the Storybook pages 'replace' the developer.wp.org pages? I notice that some of them are already directing visitors to Storybook.
It seems like a lot of potentially duplicated effort to maintain readme's and Storybook.
Overview
This is an audit of all the design guidance for the WordPress design system components. This is part of a joint effort to understand and audit the current system at a higher level.
Goal 🎯
Make sense of the state of our design guidance across our different reference sites and recommend a path forward to state-of-the-art documentation for designers and developers.
Definition of done 💫
What we're evaluating 🗒️
Additionally, we’ll be assessing comprehensiveness. In the next version, a component has enough design guidance it includes the following sections: