Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Show MDX errors using our error overlay #21369

Merged
merged 3 commits into from
Mar 3, 2023
Merged

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Mar 3, 2023

Closes #20841

What I did

Made it so docs actually renders errors using our typically rendering stack if the MDX file has a issue

How to test

You can visit this entry, or make your own: http://localhost:6006/?path=/docs/addons-docs-docs2-error--docs

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

@tmeasday tmeasday changed the title Docs: Show errors using our error display when docs error Docs: Show MDX errors using our error overlay Mar 3, 2023
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Does this affect crash reporting at all?

@tmeasday
Copy link
Member Author

tmeasday commented Mar 3, 2023

I don't think so @shilman -- this is a runtime error.

@shilman shilman merged commit 4e58b01 into next Mar 3, 2023
@shilman shilman deleted the 20841-show-docs-errors branch March 3, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Preview breaks in MDX when Story block of property is undefined
2 participants