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

Update "How it Works" Guide #2376

Open
deepsheth opened this issue Dec 18, 2022 · 1 comment
Open

Update "How it Works" Guide #2376

deepsheth opened this issue Dec 18, 2022 · 1 comment
Labels
documentation Changes only affect the documentation

Comments

@deepsheth
Copy link

Is your feature request related to a problem? Please describe.
With the release of theme-ui v0.15, the How it Works guide looks slightly outdated.

Specifically the guide says

The Theme UI ThemeProvider component is a wrapper around MDX's MDXProvider, which adds custom React components to context

contradicts what's on the Migration Guide

MDXProvider is no longer included in Theme UI ThemeProvider, and has been removed in favour of an useThemedStylesWithMdx hook.

Describe the solution you'd like
Update the How it Works guide and the code snippet which shows the MDX Provider included inside the ThemeProvider.

@hasparus
Copy link
Member

Good catch @deepsheth! Thanks for the issue.

@hasparus hasparus added the documentation Changes only affect the documentation label Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation
Projects
None yet
Development

No branches or pull requests

2 participants