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] Create, revise, and expand System "Getting started" docs #33503

Merged
merged 25 commits into from Aug 9, 2022
Merged

[docs] Create, revise, and expand System "Getting started" docs #33503

merged 25 commits into from Aug 9, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Jul 13, 2022 •
edited

https://deploy-preview-33503--material-ui.netlify.app/system/getting-started/overview/

This PR is the final task in Issue #32275.

It creates a "Getting started" section in the MUI System docs that mirrors the format of the other Core docs with Overview / Installation / Usage as the first three pages in the user journey.

  • Create Getting started section
    • Move relevant pages and update pages.ts
    • Create Overview page
    • Create Installation page
    • Revise Basics page (renamed Usage)
    • Revise The sx prop page
    • Revise Advanced page (renamed Custom components)
  • Fix broken links
  • Add redirects

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: system Specific to @mui/system labels Jul 13, 2022
@samuelsycamore samuelsycamore mentioned this pull request Jul 13, 2022
Closed
4 tasks
@mui-bot
Copy link

mui-bot commented Jul 13, 2022 •
edited

No bundle size changes

Generated by 🚫 dangerJS against 51b73b4

@mnajdova
Copy link
Member

The structure looks good 👍

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 1, 2022
@samuelsycamore
Copy link
Member Author

Wow, this ended up requiring a lot of updated links! 😬 I'm definitely going to need a few pairs of eyes to look over these.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 1, 2022
@samuelsycamore samuelsycamore marked this pull request as ready for review August 1, 2022 21:07
@samuelsycamore
Copy link
Member Author

Not sure why this is failing ci/circleci: test_e2e_website but I assume it has to do with all the links that I broke here. 😅

mnajdova
mnajdova approved these changes Aug 2, 2022
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.

Looks great, I left just one small comment :)

@mnajdova
Copy link
Member

mnajdova commented Aug 2, 2022

Not sure why this is failing ci/circleci: test_e2e_website but I assume it has to do with all the links that I broke here. 😅

@siriwatknp can help with this :)

@samuelsycamore
Copy link
Member Author

The failed test seems to be indicating that there is a link that's missing its product prefix (i.e. /system/) but if that's the case, I couldn't find it after reviewing all the links here again.

@siriwatknp siriwatknp merged commit e4b548c into mui:master Aug 9, 2022
@siriwatknp
Copy link
Member

siriwatknp commented Aug 9, 2022 •
edited

The failed test seems to be indicating that there is a link that's missing its product prefix (i.e. /system/) but if that's the case, I couldn't find it after reviewing all the links here again.

Fixed! 51b73b4

@ZeeshanTamboli ZeeshanTamboli mentioned this pull request Aug 9, 2022
Closed
1 task
@oliviertassinari oliviertassinari mentioned this pull request Aug 13, 2022
Merged
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
@samuelsycamore
[docs] Create, revise, and expand System "Getting started" docs (mui#…
c743520 
…33503)
@samuelsycamore samuelsycamore deleted the system-revisions branch April 3, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mnajdova mnajdova mnajdova approved these changes

@oliviertassinari oliviertassinari Awaiting requested review from oliviertassinari

@siriwatknp siriwatknp Awaiting requested review from siriwatknp

@michaldudak michaldudak Awaiting requested review from michaldudak

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation package: system Specific to @mui/system
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@samuelsycamore @mui-bot @mnajdova @siriwatknp @oliviertassinari