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][joy-ui] Revise the Overview page #38842

Merged
merged 9 commits into from
Sep 15, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Sep 7, 2023

This PR revises the Joy UI Overview page, creating sections that we can directly link to in the upcoming marketing page values section. One of the things I attempted to do here is to have a concrete example of all of these values so they're not just abstract things we sell.

Although the previous principles were nice, I don't think they necessarily conveyed everything. Additionally, there was also the opportunity to put it in a more "why" fashion than before. Also, made sure to mention Material UI and Base UI where relevant. Lastly, in the future, this might be a good place to talk more about the design direction ⎯ for now, I just mentioned "Joy Design", so it's officially placed in a doc space and not just in stray GitHub/Notion discussions.

https://deploy-preview-38842--material-ui.netlify.app/joy-ui/getting-started/

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Sep 7, 2023
@danilo-leal danilo-leal added this to the Joy UI: Stable release milestone Sep 7, 2023
@danilo-leal danilo-leal self-assigned this Sep 7, 2023
@mui-bot
Copy link

mui-bot commented Sep 7, 2023

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 32eaa39

@zanivan
Copy link
Contributor

zanivan commented Sep 7, 2023

Nice one! It's way easier to scan the page and see the main why's. 🙌


I have some thoughts, though:

  • The background from the image seems a bit off when on the dark mode. Maybe it'd be better with it coded, or the gradients from Base UI introduction demos bg
Screenshot 2023-09-07 at 08 37 29
  • I wonder if we could highlight even more the main point of each one of the why's, it might help with the scannability, like for instance on Why use Joy UI:
- Maintained by MUI, Joy UI is an alternative to Material UI for projects that aren't planning to adhere to or use it as a base, the Material Design specifications.
+ Maintained by MUI, **Joy UI is an alternative to Material UI** for projects that **aren't planning to adhere to or use the Material Design** guidelines and visual as a base, .

The idea is to come up with a very targeted first sentence after the title, where we can highlight the main points.


All in all, it looks great, and I feel the principles and the other removed items will be more suited to the upcoming design direction doc 🤙

@danilo-leal
Copy link
Contributor Author

The background from the image seems a bit off when on the dark mode. Maybe it'd be better with it coded, or the gradients from Base UI introduction demos bg

Yeah, I know 😕 This image is being added on the Markdown as an image, not as a component wrapped by the Demo component. I'm not sure we have a way to toggle different images depending on the mode (the blog also doesn't have this feature) but I'd love to!

@zanivan
Copy link
Contributor

zanivan commented Sep 7, 2023

I'm not sure we have a way to toggle different images depending on the mode

Maybe we could try doing the same way we do on the templates page with the templates' covers

@danilo-leal
Copy link
Contributor Author

That could be a way out! I'll wait for @siriwatknp's perspective on this because the template thumbnails have some intricate logic there, a bit more complex than just toggling the file depending on the mode (it's a real screenshot of the current template version).

@danilo-leal
Copy link
Contributor Author

@samuelsycamore + @siriwatknp let me know if y'all managed to see this!

Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Here are some copyediting suggestions! I kind of feel like we're missing some kind of final call to action at the end. Maybe just a line or two to invite the user to move on to installation, or direct them to the Templates from here? I think if I were still debating whether or not to use Joy UI after reading this page, I'd want to jump into some CodeSandboxes and see how these components work before I commit to actually building something myself from scratch to test it out.

docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
@danilo-leal
Copy link
Contributor Author

@samuelsycamore that makes sense to me, too! It was feeling too abrupt of an ending. Just added a card section, tentatively called "Start now". It's something we could do more on the docs, so it's not just walls of text. We can tweak everything more (content, links, icons, design, etc.) but just wanted to give it a start so we can picture what it could be. Let me know suggestions of stuff we can add and copy for it!

Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Love the cards! I added a couple tiny copy edits but will go ahead and tentatively approve 👍

docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
docs/src/modules/components/JoyStartingLinksCollection.js Outdated Show resolved Hide resolved
docs/src/modules/components/JoyStartingLinksCollection.js Outdated Show resolved Hide resolved
@danilo-leal danilo-leal merged commit 1cb83a5 into mui:master Sep 15, 2023
6 checks passed
@danilo-leal danilo-leal deleted the revise-joy-overview-page branch September 15, 2023 22:36
danilo-leal added a commit to siriwatknp/material-ui that referenced this pull request Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

4 participants