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 and/or revise "Overview" pages for each MUI product #32275

Closed
4 tasks done
samuelsycamore opened this issue Apr 12, 2022 · 2 comments
Closed
4 tasks done

[docs] Add and/or revise "Overview" pages for each MUI product #32275

samuelsycamore opened this issue Apr 12, 2022 · 2 comments
Assignees
Labels
docs Improvements or additions to the documentation

Comments

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Apr 12, 2022

Tasks

Summary 💡

MUI X has a newly published Overview page, and I think we should take it a step further and create something similar for our other products.

I was reviewing the Tina CMS docs and I really like their Overview page, which is the default when you click through to their docs. It gives a brief intro of the product, and then explains the key features/selling points.

Instead of directing the reader to Installation docs for Material UI and Base, I think we should follow Tina's example and create pages to answer "Why?" for each of these products.

This way, when a new user lands in our docs and isn't sure which product is best for their project, they'll be able to find a quick summary of each that explains its main selling points.

Examples 🌈

Screen Shot 2022-04-12 at 5 28 42 PM

Motivation 🔦

With the release of new documentation restructuring, I'm not sure that "Installation" is the best page to serve as the landing page for each product. This is a great opportunity to clarify our branding and do some (tasteful 😅) marketing in our docs.

@samuelsycamore samuelsycamore added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Apr 12, 2022
@samuelsycamore samuelsycamore self-assigned this Apr 12, 2022
@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Apr 12, 2022
@siriwatknp
Copy link
Member

This is a great opportunity to clarify our branding and do some (tasteful 😅) marketing in our docs.

Could not agree more!

@samuelsycamore samuelsycamore changed the title [docs] Add "Overview" page for each MUI product [docs] Add and/or revise "Overview" pages for each MUI product Apr 28, 2022
@samuelsycamore
Copy link
Contributor Author

samuelsycamore commented Apr 28, 2022

Boilerplate for Overview pages

---
title: Overview
---

# {{productName}} - Overview

<p class="description">Quick description.</p>

## Introduction

2-3 short paragraphs.

## Advantages of {{productName}}

list of 3-4 items.

## {{productName}} vs. {{otherSimilarProductOfOurs}}

2-3 short paragraphs explaining how product differs from our other offerings.

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
Projects
None yet
Development

No branches or pull requests

2 participants