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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #1877

Merged
merged 4 commits into from
Jul 31, 2021
Merged

Improve documentation #1877

merged 4 commits into from
Jul 31, 2021

Conversation

hasparus
Copy link
Member

@hasparus hasparus commented Jul 31, 2021 •
edited
Loading

What's inside?

  • Moved the mention of ThemeProvider above the note about using Theme UI in Gatsby.
  • Changed intro code snippets to TypeScript — they have just one type, and implementing a language toggle would take some time, so this should be passable for JS users.
  • Expanded on readmes for @theme-ui/css and @theme-ui/core, and showed the readme for @theme-ui/css in the app.

Closes #1876, I hope.

📦 Published PR as canary version: 0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0

✨ Test out this PR locally via:

npm install @theme-ui/color-modes@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/color@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/components@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/core@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/css@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/custom-properties@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/editor@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install gatsby-plugin-theme-ui@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install gatsby-theme-style-guide@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install gatsby-theme-ui-layout@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/match-media@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/mdx@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/parse-props@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-base@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-bootstrap@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-bulma@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-dark@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-deep@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-funk@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-future@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-polaris@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-roboto@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-sketchy@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-swiss@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-system@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-tailwind@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/preset-tosh@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/presets@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/prism@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/sidenav@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/style-guide@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/tachyons@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/tailwind@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/theme-provider@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install theme-ui@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
npm install @theme-ui/typography@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
# or 
yarn add @theme-ui/color-modes@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/color@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/components@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/core@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/css@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/custom-properties@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/editor@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add gatsby-plugin-theme-ui@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add gatsby-theme-style-guide@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add gatsby-theme-ui-layout@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/match-media@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/mdx@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/parse-props@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-base@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-bootstrap@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-bulma@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-dark@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-deep@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-funk@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-future@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-polaris@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-roboto@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-sketchy@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-swiss@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-system@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-tailwind@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/preset-tosh@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/presets@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/prism@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/sidenav@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/style-guide@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/tachyons@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/tailwind@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/theme-provider@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add theme-ui@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0
yarn add @theme-ui/typography@0.11.0-canary.1877.9468a3809c2c39f70920eacac958a71b03651601.0

@hasparus hasparus requested a review from lachlanjc July 31, 2021 18:16
@vercel
Copy link

vercel bot commented Jul 31, 2021 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/systemui/theme-ui/7HzTSZRL7w8HvPHTG1ZizQNdarQL
✅ Preview: https://theme-ui-git-docs-theme-provider-earlier-systemui.vercel.app

@hasparus hasparus mentioned this pull request Jul 31, 2021
Closed
@hasparus hasparus requested a review from fcisio July 31, 2021 19:12
lachlanjc
lachlanjc approved these changes Jul 31, 2021
View reviewed changes
Copy link
Member

@lachlanjc lachlanjc left a comment

Choose a reason for hiding this comment

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

Wow, thank you!! Big improvement.

@hasparus
Copy link
Member Author

hasparus commented Jul 31, 2021 •
edited
Loading

Wow, thank you!! Big improvement.

Thank you!
Dude, I was wondering why people don't use @theme-ui/core in smaller projects where they don't need color modes and MDX. Turns out we barely documented it :D

@hasparus hasparus merged commit b639354 into develop Jul 31, 2021
@hasparus hasparus deleted the docs-theme-provider-earlier branch July 31, 2021 19:31
@hasparus
Copy link
Member Author

🚀 PR was released in v0.11.0 🚀

1 similar comment
@hasparus
Copy link
Member Author

🚀 PR was released in v0.11.0 🚀

@hasparus hasparus added the released This issue/pull request has been released. label Aug 25, 2021
@hasparus
Copy link
Member Author

🚀 PR was released in v0.11.0 🚀

@hasparus
Copy link
Member Author

hasparus commented Sep 1, 2021

🚀 PR was released in v0.11.2-develop.0 🚀

@hasparus hasparus added the prerelease This change is available in a prerelease. label Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lachlanjc lachlanjc lachlanjc approved these changes

@fcisio fcisio Awaiting requested review from fcisio

Assignees
No one assigned
Labels
prerelease This change is available in a prerelease. released This issue/pull request has been released.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs don't tell you to use ThemeProvider early enough.
2 participants
@hasparus @lachlanjc