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.

Sign up for GitHub

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

Jump to bottom

[docs][base-ui] Structure and style revisions for Component docs #38826

Merged
merged 35 commits into from
Sep 8, 2023
Merged

[docs][base-ui] Structure and style revisions for Component docs #38826

merged 35 commits into from
Sep 8, 2023

Conversation

samuelsycamore
Copy link
Contributor

@samuelsycamore samuelsycamore commented Sep 6, 2023 •
edited
Loading

Part of mui/base-ui#49 - continuation of #38529

This PR updates the structure and formatting of the Base UI docs to eliminate some unneeded copy and code snippets. I've also done another pass on style and grammar, notably capitalizing component names across the board.

This is the last round of editing that I intend to do on the existing content of the Base docs before the stable release.

  • removed boilerplate copy and code snippets from ## Component sections along with ### Usage and ### Basics headers
  • capitalized component names, occasionally added <ComponentCase /> for clarity
  • heavy revisions to (Dropdown) Menu page in light of the addition of the <Dropdown /> component
  • more detailed revisions to Select page as it's changed significantly since the first draft
  • detailed editing and reorganizing of Number Input page

Pages with significant changes:

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base labels Sep 6, 2023
@mui-bot
Copy link

mui-bot commented Sep 6, 2023 •
edited
Loading

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against cda0bd7

@samuelsycamore samuelsycamore mentioned this pull request Sep 6, 2023
Open
@samuelsycamore samuelsycamore self-assigned this Sep 6, 2023
@samuelsycamore samuelsycamore marked this pull request as ready for review September 6, 2023 21:01
danilo-leal
danilo-leal approved these changes Sep 6, 2023
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Love this! Getting very excited by all of these editing polishes 🤘 Skimmed through the changes, and everything looks fine to me.

@samuelsycamore
Copy link
Contributor Author

samuelsycamore commented Sep 7, 2023 •
edited
Loading

One more tiny change: I dropped the CSS classes section from the Menu doc because they are all documented in the API tab now. I believe it's the only page that has this section.

mnajdova
mnajdova approved these changes Sep 7, 2023
View reviewed changes
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

Much cleaner. Left one comment/question :)

docs/data/base/components/menu/menu.md Outdated Show resolved Hide resolved
@samuelsycamore samuelsycamore merged commit 95f30bb into mui:master Sep 8, 2023
5 checks passed
xcode-it pushed a commit to xcode-it/material-ui that referenced this pull request Sep 11, 2023
@samuelsycamore @mnajdova @xcode-it
[docs][base-ui] Structure and style revisions for Component docs (mui…
eff9727 
…#38826)

Signed-off-by: Sam Sycamore <[email protected]>
Co-authored-by: Marija Najdova <[email protected]>
@samuelsycamore samuelsycamore deleted the base-revisions-two branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danilo-leal danilo-leal danilo-leal approved these changes

@mnajdova mnajdova mnajdova approved these changes

@michaldudak michaldudak Awaiting requested review from michaldudak

Assignees

@samuelsycamore samuelsycamore

Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@samuelsycamore @mui-bot @mnajdova @danilo-leal