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] Add, update, and revise marketing pages for all products #32414

Closed
2 of 5 tasks
samuelsycamore opened this issue Apr 21, 2022 · 10 comments
Closed
2 of 5 tasks

[docs] Add, update, and revise marketing pages for all products #32414

samuelsycamore opened this issue Apr 21, 2022 · 10 comments
Assignees
Labels
docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused.

Comments

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Apr 21, 2022

Summary 💡

Currently:

  • mui.com/core and mui.com/x are both outdated
  • mui.com/material-ui is just a list of components
  • mui.com/base and mui.com/system don't exist

I think all of these pages are due for updating (or creating). For the individual products, these pages would be the more marketing-oriented counterparts to the "Overview" page that X has (and Base has as a WIP #32310) in the docs.

@danilo-leal I'd love to get your thoughts on the design for these pages. Should we stick with the basic template of the Core and X pages for Base/System/Material UI (and eventually Joy!)? How do we show off Base in particular?

Should the X products get their own individual marketing pages? (e.g. mui.com/x/data-grid) cc: @joserodolfofreitas @flaviendelangle

Would it make more sense for the structure to be like mui.com/material-ui or mui.com/core/material-ui? My gut says the former is better for SEO but I could be persuaded to go either way.

Stuff to do:

  • revise copy on mui.com/x
  • revise copy (and possibly design) on mui.com/core
  • revise mui.com/material-ui
  • create mui.com/base
  • create mui.com/system
@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation website Pages that are not documentation-related, marketing-focused. labels Apr 21, 2022
@samuelsycamore samuelsycamore self-assigned this Apr 21, 2022
@flaviendelangle
Copy link
Member

Should the X products get their own individual marketing pages?

I think it could become interesting later on, when we have a 3rd set of components (Charts ?).

For now, If we are able to restructure mui.com/x to host both the datagrid and the pickers, I think it's better.
Especially if we improve our X overview pages and if we create new marketing pages for advanced examples (like discussed a few weeks ago).

A few things I think we could improve on mui.com/x :

  • A new section concerning the Date Range Picker (similar to Data Grid - A level of performance and quality that hasn't been seen before)

  • A better feature list for the Data Grid in Data Grid - A level of performance and quality that hasn't been seen before, for instance the editing do not use the new editing API and we could probably a "Grouping"

  • A more advanced custom theme in Theming - Advanced and beautiful (which is also related only to the datagrid, the whole structure of the page should be improved with the arrival of the pickers), maybe we will soon be able to do a POC with Joy for instance.

  • The Roadmap is outdated (these hardcoded values are really problematic if we want to avoid outdated info, Grouping is released for instance)

  • The Tree View might be released but it is not part of X, marking it as such is not great

  • Link the Much more of the datagrid features to a good feature list, not the one currently used

  • In the data grid example of Powerful components for advanced use-cases, remove the form with Dataset, Rows and Page size, the example is to small for it to be relevant

  • Update the Available with MIT and commercial licenses description for premium plan when available

@sumitsaurabh927
Copy link

I'd love to contribute to this. What shall I do?

@samuelsycamore
Copy link
Contributor Author

Thank you for the feedback @flaviendelangle ! That is super helpful.

@samuelsycamore
Copy link
Contributor Author

Hey @sumitsaurabh927 👋 it's nice to see you here!

I'm glad you're interested in contributing. This issue is better suited to internal folks at MUI who've worked on shaping the company's branding and messaging, so I don't think there's much I could ask you to do here. It's more like a public bulletin board where I can show the team what tasks I'm working on, and request feedback.

Feel free to have a look around our good first issues and grab anything you might be interested in working on. If you're looking to contribute to the docs specifically, please email me at [email protected] and I'll be happy to show you where and how we could use your help!

@danilo-leal
Copy link
Contributor

Thanks, Sam for putting this up! Totally on board for this, I was already sketching something toward that direction for the Core page, resonating a bit more with the idea of a collection of libraries instead of a synonym for Material UI (current reality).

Screen Shot 2022-04-26 at 01 17 52

Pages for Joy and Material UI could use their default theme so it's straight up clear what folks will get out of installing the packages. As for Base and System, they might probably continue using the MUI branding theme, I guess.

I guess we could try thinking about content first and design later. What do we want to highlight and talk about on each of these pages? Then we figure out how to showcase them. What do you think about it?

Lastly, I think that most of what @flaviendelangle mentioned can be done today without any major design implication, it's mostly code and messaging adjustment. The one that makes me wonder though is "A more advanced custom theme"—let me know what you meant by that! Also, one easy/quick fix for the Roadmap section is simply deleting the "Work in progress" Data Grid column there. We release new Data Grid features way faster than new X components, so having to update that is definitely a hassle.

@flaviendelangle
Copy link
Member

flaviendelangle commented Apr 26, 2022

A more advanced custom theme

I don't have a clear idea of how it could be improved
But I feel like the current custom theme could be more ... custom. For instance with another pagination button, striped rows, row margin, ... to demonstration various kind of UI changes.

@flaviendelangle
Copy link
Member

Do we have a vision about this topic ?
I can do some basic changes (like removing the "In progress" for the date range piker)

@joserodolfofreitas in the coming months I think it would be nice to improve the content of the X home page on the marketing website.

@samuelsycamore
Copy link
Contributor Author

Thanks for unearthing this @flaviendelangle! 😁 I agree that these pages are now long overdue for updating. Since this is a topic that spans marketing, design, and DX, maybe this would be a good project for us to pick up in the next available product marketing meeting like we talked about in the X team split retro? cc: @gerdadesign

As for where things currently stand, we've talked a lot on the Core side of things about prioritizing a landing page for MUI Base since we've just "officially" launched it in alpha. I might have dropped the ball there 😅 and I should probably just ask @danilo-leal if his design is ready to go so I can start assembling it.

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented Sep 15, 2022

think it would be nice to improve the content of the X home page on the marketing website.

+1

maybe this would be a good project for us to pick up in the next available product marketing meeting like we talked about in the X team split retro?

+1

I'm adding it as an initiative for Q4.

@samuelsycamore
Copy link
Contributor Author

Closing this, as most of these pages have been revised, or else they're not a priority at this time.

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 website Pages that are not documentation-related, marketing-focused.
Projects
None yet
Development

No branches or pull requests

5 participants