base-ui
base-ui copied to clipboard
[docs-infra] Migrate to @mui/internal-docs-infra Type Generation
[!IMPORTANT] This PR is still a work in progress.
Migrates this repo to use @mui/internal-docs-infra loadPrecomputedTypesMeta (being worked on in https://github.com/mui/mui-public/pull/489). Maintains the existing design and theme.
Preview: https://deploy-preview-2932--base-ui.netlify.app/react/components/accordion#api-reference
New Features
- Fixes cache key issue with existing type metadata pipeline
- Removes the need to remember to run
pnpm run docs:api, simply runningpnpm run docs:build(orpnpm run docs:devand viewing the page) will update the types - Supports Hot Reloading Type Meta
- Build time caching for type meta and highlighting per entrypoint
- Using Typescript Language Service API, reduces single page typedoc generation from
4sto0.3s(93% decrease) with subsequent navigations in0.15s - Improved Developer Experience for (Cmd/Ctrl)+Clicking imports in VS Code
- Cleaner diffs for generated files using markdown
- CI checks for Markdown content (e.g. Vale) now run on the typedocs
- Committed files are copied 1:1 into llms.txt markdown version
- Types can be viewed directly in GitHub, which may improve Github Copilot's understanding of the repo
pnpm add https://pkg.pr.new/mui/base-ui/@base-ui-components/react@2932
pnpm add https://pkg.pr.new/mui/base-ui/@base-ui-components/utils@2932
commit: c0e52e3
Bundle size report
| Bundle | Parsed size | Gzip size |
|---|---|---|
| @base-ui-components/react | 0B(0.00%) | 0B(0.00%) |
Deploy Preview for base-ui ready!
| Name | Link |
|---|---|
| Latest commit | c0e52e3e1e5f6f7b08f345d4548cd8da976010fc |
| Latest deploy log | https://app.netlify.com/projects/base-ui/deploys/68eee204bdf7c40008e077c5 |
| Deploy Preview | https://deploy-preview-2932--base-ui.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.