[docs-infra] mui.com/docs does not exist
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Duplicates
- I have searched the existing issues
Latest version
- I have tested the latest version
Summary 💡
Now that each of MUI's products has its own documentation, we need some kind of unifying landing page to show users how to make the most of our docs to find what they need.
I'm envisioning a "Welcome" page at mui.com/docs similar to plausible.io/docs. This would be like an Overview of the Overview pages that we've been publishing for each of the products—one or two lines introducing the products, plus details about how to use the docs (search, play with codesandbox demos), how to get help, how to submit issues, etc.
Once we've established this new area of the docs, we can expand it over time to include any documentation that applies across all products. But I think it needs to start with a single landing page.
Examples 🌈
Motivation 🔦
When users click on Docs in the mui.com nav bar, it feels like it should lead to mui.com/docs rather than forcing them to choose one of our products. What if they don't know which one to select? They should be able to easily compare the products in one location without having to read multiple docs in different places.
Benchmark
- Introduction docs page https://www.apollographql.com/docs/ Apollo Docs Home
- Generic list https://www.twilio.com/docs
- Generic list https://developers.google.com/
- Generic list https://grafana.com/docs/
- Generic list https://docs.konghq.com/
- No centralized docs page https://www.hashicorp.com/products/terraform
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.