[docs] Prepare scripts for migrating to new structure #30386
Conversation
siriwatknp
changed the title
…docs/migration-preparation
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
| @@ -116,7 +116,7 @@ function reduceChildRoutes(context) { | |||
|
|
|||
| if (page.children && page.children.length > 1) { | |||
| const title = pageToTitleI18n(page, t); | |||
| const topLevel = activePage ? activePage.pathname.indexOf(`${page.pathname}/`) === 0 : false; | |||
There was a problem hiding this comment.
/ is not necessary which makes the new URLs impossible. eg:
{
pathname: '/material/react-'
children: [
{ pathname: '/material/react-buttons' },
]
}The logic will compare /material/react-/ with /material/react-
| { pathname: '/material/react-use-media-query', title: 'useMediaQuery' }, | ||
| ], | ||
| }, | ||
| { |
There was a problem hiding this comment.
Why are the data-grid pages here?
There was a problem hiding this comment.
We currently have data-grid in the components. I group all data-grid related to one link so that the people who are familiar with the previous layout don't confuse.
| paths: [ | ||
| path.join(__dirname, '../../../packages/mui-lab/src'), | ||
| path.join(__dirname, '../../../packages/mui-material/src'), | ||
| path.join(__dirname, '../../../packages/mui-base/src'), |
There was a problem hiding this comment.
because @mui/base is a dependency on material.
There was a problem hiding this comment.
This part is related to only components (neglect utilities, hooks or constants for now)
How can we verify that all pages are identical as before? |
e2e tests should verify that the change is safe by running:
|
|
All three commands ( I think |
Good point, we haven't discussed it and I would leave that to @danilo-leal. I don't think we need to consider it in this PR and let's keep them the same as before is safest for now. |
This PR update the migration and related scripts to generate pages & APIs according to the decided URLs. eg:
/components/buttons=>/material/react-buttons/components/data-grid/data-grid=>/x/data-grid/react-data-grid/api/button-unstyled=>/base/api/mui-base/button-unstyledThis is a part of the 1st phase in #30091
Summary
Review recommend
yarn docs:migrate:pages && yarn docs:api(you should see 5k+ of changes, the changes won't be committed in this PR)yarn docs:devyarn test:e2e-website:dev(all the tests should pass)