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.

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] Move unstyled components' docs to the Base space #31414

Closed
17 tasks done
michaldudak opened this issue Mar 11, 2022 · 2 comments
Closed
17 tasks done

[docs] Move unstyled components' docs to the Base space #31414

michaldudak opened this issue Mar 11, 2022 · 2 comments
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base umbrella For grouping multiple issues to provide a holistic view

Comments

@michaldudak
Copy link
Member

michaldudak commented Mar 11, 2022

This is an umbrella issue to track moving the unstyled components' documentation from Material UI to the Base space.

Docs to move:


cc @mui/core

@michaldudak michaldudak added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base umbrella For grouping multiple issues to provide a holistic view labels Mar 11, 2022
@siriwatknp
Copy link
Member

siriwatknp commented Mar 11, 2022

#31395 Should be merged before continuing the rest of the pages because there are updates on the build-api scripts.

After that, this is the checklist when moving pages from Material UI to MUI Base:

  • Remove unstyled component files (.js & .json) from /pages/api-docs/...

  • Remove unstyled component from material-ui component markdown components, add unstyled: $url and packageName: '@mui/base'

    // data/material/components/button/buttons.md
    ---
      product: material-ui
      title: React Button component
    - components: Button, IconButton, ButtonBase, LoadingButton, ButtonUnstyled
    + components: Button, IconButton, ButtonBase, LoadingButton 
      materialDesign: https://material.io/components/buttons
      githubLabel: 'component: button'
      waiAria: https://www.w3.org/TR/wai-aria-practices/#button
    + unstyled: /base/react-button/
    + packageName: '@mui/base'
    ---
  • Remove unstyled section from the markdown file (the section is auto-generated if it sees unstyled: /base/react-button/ in the markdown header.

  • Add the migrated component to the line: 105 in docs/scripts/buildApiUtils.ts

    const migratedBaseComponents = [...] // this will prevent the API page generation to the old docs

After complete the checklist, run yarn docs:api as usual and you should see the changes in

  • the "Demos" & "API" comment in unstyled component .tsx should link to /base/react-...
  • the API .json in docs/pages/base/api/...json should have the correct demo url

@michaldudak
Copy link
Member Author

I'm closing this issue as all the components' docs were moved. The useAutocomplete will be moved when its API and internals are changed to be consistent with other MUI Base hooks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

2 participants