Open
Description
Is your feature request related to a problem? Please describe
@ghengeveld pointed out that our redbox errors are fairly scary and don't include actionable feedback to help resolve the issue and proposed we move to a format similar to the error style in the Interactions addon panel:
I think this is an excellent proposal so I mocked up what that could look like.
Describe the solution you'd like
I propose we have an error system that looks something like this:
The above is an example of a known error where:
- We provide a short description of the error followed by details and instructions on what steps to take to resolve it.
- We provide a formatted version of the error (if feasible) to improve readability in addition to some syntax highlighting.
- We provide a link to related docs (if available) and an action to copy the error for sharing.
- OS, Browser, viewport, and branch details - this is not necessary for a V1
If the error is something we don't have suggestions for, it would look like this:
Here is what a totally unformatted error might look like:
If you are interested in working on this, please send me a message on the Storybook Discord and I will provide Figma assets.