Docs: Add error message guidance. - #81143
Conversation
ramonjd
left a comment
There was a problem hiding this comment.
just left some non-blocking observations... thanks!
|
|
||
| <Meta title="Design System/Patterns/Error Messages" /> | ||
|
|
||
| # Error Messages |
There was a problem hiding this comment.
docs/contributors/documentation/copy-guide.md already has a section titled "Error Messaging". Is story book separate or should it be canonical?
If the preference is to link off to the official GB docs, then I think there's scope to give principles 1β5 a hair cut then add the link off to docs/contributors/documentation/copy-guide.md
What do you think?
There was a problem hiding this comment.
Good question. Storybook is contextual to the design system in a way that those more formal docs are not, and more easy to maintain. I'd prefer keeping most of it here. For now I'll add a link.
|
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. |
|
Thanks for all the feedback, agree with all of it. Just connecting a dot to a comment here: #81195 (comment) |
353a511 to
e4c3fe3
Compare
|
Solid feedback, addressed all of it. |
ramonjd
left a comment
There was a problem hiding this comment.
LGTM
Thanks for the changes. I just pushed a small commit that escapes curly braces, the power of which took down the storybook build!! π£
b7a5fdf to
826c772
Compare
|
Thanks for the help here! |
Co-authored-by: jasmussen <joen@git.wordpress.org> Co-authored-by: ramonjd <ramonopoly@git.wordpress.org>
What?
Related to #81123 but also Defensive Data Design. Adds Storybook docs on how to write good error messages.
This is a first draft, I expect improvements in the future.
Testing Instructions
npm run storybook:dev
Use of AI Tools
Yes.