-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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][base-ui] Revise the structure of the Component docs #38529
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really like this new structure! Makes a ton of sense to me 🤙
Ah shoot @siriwatknp I should have marked this as a "DO NOT MERGE"—I'd like to wait to apply the updated format to all pages before this PR goes out. Can we revert it? |
Oops! sorry. |
No worries @siriwatknp! It's not a big deal to have this merged early—I'm sure we'll still do a couple more drafts of these docs before the stable release. |
In the current version of the Base UI docs, the headers are structured like this:
Preview: https://deploy-preview-38529--material-ui.netlify.app/base-ui/react-switch/
In practice, there's a lot of overlap between the
Introduction
,Usage
, andBasics
sections, and some of the docs have redundant content repeated in each—particularly since we added the Intro playgrounds.This PR:
Usage
andBasics
in to one section calledUsage
I also couldn't resist doing some copyediting, mostly to the Autocomplete page.
Before:
After:
Right now this PR only involves a few of the pages, because I want to make sure we agree on the updated format before applying it to all others. I tried to take a sample of several different kinds of pages to see how the new format works. There may be other kinks to work out in the next pass, but I think this is good way to proceed.