[docs-infra] Migrate to @mui/internal-docs-infra Type Generation #2932

dav-is · 2025-10-07T19:59:05Z

Migrates this repo to use @mui/internal-docs-infra useTypes (added in mui/mui-public#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 running pnpm run docs:build (or pnpm run docs:dev and viewing the page) will update the types. To manually update all the types.md without the cache you can run pnpm docs:validate --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 4s to 0.3s (93% decrease) with subsequent navigations in 0.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
Adds support for class exports like Dialog.Handle
All hardcoded type tables replaced with automated pipeline (e.g. useRender and other hooks)
Add namespaced types like AlertDialog.Trigger.State, or Checkbox.Root.ChangeEventDetails
Known types within the page can link to other types, like className: string | ((state: AlertDialog.Popup.State) => string | undefined) will have AlertDialog.Popup.State linked to https://base-ui.com/react/components/alert-dialog#popup.state

pkg-pr-new · 2025-10-07T20:06:58Z

base-ui-tanstack-start

vite-css-base-ui-example

pnpm add https://pkg.pr.new/mui/base-ui/@base-ui/react@2932

pnpm add https://pkg.pr.new/mui/base-ui/@base-ui/utils@2932

commit: 980d954

mui-bot · 2025-10-07T20:08:01Z

Bundle size report

Bundle	Parsed size	Gzip size
@base-ui/react	🔺+11B^(0.00%)	🔺+6B^(0.00%)

Details of bundle changes

Check out the code infra dashboard for more information about this PR.

netlify · 2025-10-09T00:25:56Z

✅ Deploy Preview for base-ui ready!

Name	Link
🔨 Latest commit	`980d954`
🔍 Latest deploy log	https://app.netlify.com/projects/base-ui/deploys/698b3356296f4e0008b20c34
😎 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.

greptile-apps · 2026-02-09T22:51:11Z

Too many files changed for review. (402 files found, 100 file limit)

Copilot

Pull request overview

Migrates the docs API reference/type metadata pipeline to @mui/internal-docs-infra type generation and updates the docs + llms.txt generation flow to consume the new precomputed types output.

Changes:

Replaced <Reference /> usage in component docs pages with per-part <Types*.X /> type blocks backed by new types.ts entries.
Added generated types.md files and types.ts wiring for multiple components.
Updated docs build tooling (Next config + llms.txt generator) to load and inline precomputed types, and removed the old reference processor.

Reviewed changes

Copilot reviewed 69 out of 402 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
.circleci/config.yml	Removes the standalone `docs:api` generation/dirty-check step in CI.
docs/next.config.mjs	Adds webpack/turbopack loaders to load precomputed types from `types.ts`; removes `rehypeReference`.
docs/package.json	Switches `@mui/internal-docs-infra` dependency to a URL-pinned build.
docs/scripts/generateLlmTxt/mdxToMarkdown.mjs	Replaces `<Reference />` processing with typedoc/types.md inlining; removes Type* nodes/headings in the markdown output.
docs/scripts/generateLlmTxt/typedocProcessor.mjs	New processor that reads `types.md` and returns AST nodes for llms.txt generation.
docs/scripts/generateLlmTxt/referenceProcessor.mjs	Deletes the old Reference JSON-to-table processor.
docs/scripts/generateLlmTxt/resolver.mjs	Hardens markdown link resolution when `urlPath`/`urlsWithMdVersion` are missing.
docs/scripts/generateLlmTxt/snapshots/mdxToMarkdown.test.mjs.snap	Updates snapshots to reflect new type inlining output.
docs/src/app/(docs)/react/components/accordion/page.mdx	Replaces `<Reference />` with `<TypesAccordion.* />` blocks.
docs/src/app/(docs)/react/components/accordion/types.ts	Adds precomputed types wiring for Accordion.
docs/src/app/(docs)/react/components/accordion/types.md	Adds generated Accordion API/types markdown.
docs/src/app/(docs)/react/components/alert-dialog/page.mdx	Replaces `<Reference />` with `<TypesAlertDialog.* />` blocks.
docs/src/app/(docs)/react/components/alert-dialog/types.ts	Adds precomputed types wiring for AlertDialog.
docs/src/app/(docs)/react/components/alert-dialog/types.md	Adds generated AlertDialog API/types markdown.
docs/src/app/(docs)/react/components/autocomplete/page.mdx	Replaces `<Reference />` with `<TypesAutocomplete.* />` blocks (incl hooks).
docs/src/app/(docs)/react/components/autocomplete/types.ts	Adds precomputed types wiring for Autocomplete.
docs/src/app/(docs)/react/components/avatar/page.mdx	Replaces `<Reference />` with `<TypesAvatar.* />` blocks.
docs/src/app/(docs)/react/components/avatar/types.ts	Adds precomputed types wiring for Avatar.
docs/src/app/(docs)/react/components/avatar/types.md	Adds generated Avatar API/types markdown.
docs/src/app/(docs)/react/components/button/page.mdx	Replaces `<Reference />` with `<TypesButton />`.
docs/src/app/(docs)/react/components/button/types.ts	Adds precomputed types wiring for Button.
docs/src/app/(docs)/react/components/button/types.md	Adds generated Button API/types markdown.
docs/src/app/(docs)/react/components/checkbox/page.mdx	Replaces `<Reference />` with `<TypesCheckbox.* />` blocks.
docs/src/app/(docs)/react/components/checkbox/types.ts	Adds precomputed types wiring for Checkbox.
docs/src/app/(docs)/react/components/checkbox/types.md	Adds generated Checkbox API/types markdown.
docs/src/app/(docs)/react/components/checkbox-group/page.mdx	Replaces `<Reference />` with `<TypesCheckboxGroup />`.
docs/src/app/(docs)/react/components/checkbox-group/types.ts	Adds precomputed types wiring for CheckboxGroup.
docs/src/app/(docs)/react/components/checkbox-group/types.md	Adds generated CheckboxGroup API/types markdown.
docs/src/app/(docs)/react/components/collapsible/page.mdx	Replaces `<Reference />` with `<TypesCollapsible.* />` blocks.
docs/src/app/(docs)/react/components/collapsible/types.ts	Adds precomputed types wiring for Collapsible.
docs/src/app/(docs)/react/components/collapsible/types.md	Adds generated Collapsible API/types markdown.
docs/src/app/(docs)/react/components/combobox/page.mdx	Replaces `<Reference />` and hardcoded hook tables with `<TypesCombobox.* />` blocks.
docs/src/app/(docs)/react/components/combobox/types.ts	Adds precomputed types wiring for Combobox.
docs/src/app/(docs)/react/components/context-menu/page.mdx	Replaces `<Reference />` blocks with `<TypesContextMenu.* />` blocks.
docs/src/app/(docs)/react/components/context-menu/types.ts	Adds precomputed types wiring for ContextMenu.
docs/src/app/(docs)/react/components/dialog/page.mdx	Replaces `<Reference />` with `<TypesDialog.* />` blocks (incl handle).
docs/src/app/(docs)/react/components/dialog/types.ts	Adds precomputed types wiring for Dialog.
docs/src/app/(docs)/react/components/dialog/types.md	Adds generated Dialog API/types markdown.
docs/src/app/(docs)/react/components/field/page.mdx	Replaces `<Reference />` with `<TypesField.* />` blocks.
docs/src/app/(docs)/react/components/field/types.ts	Adds precomputed types wiring for Field.
docs/src/app/(docs)/react/components/field/types.md	Adds generated Field API/types markdown.
docs/src/app/(docs)/react/components/fieldset/page.mdx	Replaces `<Reference />` with `<TypesFieldset.* />` blocks.
docs/src/app/(docs)/react/components/fieldset/types.ts	Adds precomputed types wiring for Fieldset.
docs/src/app/(docs)/react/components/fieldset/types.md	Adds generated Fieldset API/types markdown.
docs/src/app/(docs)/react/components/form/page.mdx	Replaces `<Reference />` with `<TypesForm />`.
docs/src/app/(docs)/react/components/form/types.ts	Adds precomputed types wiring for Form.
docs/src/app/(docs)/react/components/form/types.md	Adds generated Form API/types markdown.
docs/src/app/(docs)/react/components/input/page.mdx	Replaces `<Reference />` with `<TypesInput />`.
docs/src/app/(docs)/react/components/input/types.ts	Adds precomputed types wiring for Input.
docs/src/app/(docs)/react/components/input/types.md	Adds generated Input API/types markdown.
docs/src/app/(docs)/react/components/menu/page.mdx	Replaces `<Reference />` with `<TypesMenu.* />` blocks (incl handle).
docs/src/app/(docs)/react/components/menu/types.ts	Adds precomputed types wiring for Menu.
docs/src/app/(docs)/react/components/menubar/page.mdx	Replaces `<Reference />` with `<TypesMenubar />`.
docs/src/app/(docs)/react/components/menubar/types.ts	Adds precomputed types wiring for Menubar.
docs/src/app/(docs)/react/components/menubar/types.md	Adds generated Menubar API/types markdown.
docs/src/app/(docs)/react/components/meter/page.mdx	Replaces `<Reference />` with `<TypesMeter.* />` blocks.
docs/src/app/(docs)/react/components/meter/types.ts	Adds precomputed types wiring for Meter.
docs/src/app/(docs)/react/components/meter/types.md	Adds generated Meter API/types markdown.
docs/src/app/(docs)/react/components/navigation-menu/page.mdx	Replaces `<Reference />` with `<TypesNavigationMenu.* />` blocks.
docs/src/app/(docs)/react/components/navigation-menu/types.ts	Adds precomputed types wiring for NavigationMenu.
docs/src/app/(docs)/react/components/navigation-menu/types.md	Adds generated NavigationMenu API/types markdown.
docs/src/app/(docs)/react/components/number-field/page.mdx	Replaces `<Reference />` with `<TypesNumberField.* />` blocks.
docs/src/app/(docs)/react/components/number-field/types.ts	Adds precomputed types wiring for NumberField.
docs/src/app/(docs)/react/components/number-field/types.md	Adds generated NumberField API/types markdown.
docs/src/app/(docs)/react/components/popover/page.mdx	Replaces `<Reference />` with `<TypesPopover.* />` blocks (incl handle).
docs/src/app/(docs)/react/components/popover/types.ts	Adds precomputed types wiring for Popover.
docs/src/app/(docs)/react/components/popover/types.md	Adds generated Popover API/types markdown.
docs/src/app/(docs)/react/components/preview-card/page.mdx	Replaces `<Reference />` with `<TypesPreviewCard.* />` blocks (incl handle).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-09T23:16:18Z

docs/scripts/generateLlmTxt/typedocProcessor.mjs

+
+  // Parse the markdown content and add it to the result
+  // Removing the leading title and description
+  return parseMarkdown(typesContent).splice(3);


resultis never returned, so the intended "## Types" heading is dropped. Additionally, usingsplice(3)mutates the parsed AST array and returns only the tail; this makes the output dependent on a fixed node count and currently discards the heading you just constructed. Consider returning a concatenated array (e.g.,return [...result, ...parseMarkdown(typesContent).slice(3)]`) so the heading is preserved and the parse output isn’t mutated.

Suggested change

return parseMarkdown(typesContent).splice(3);

return [...result, ...parseMarkdown(typesContent).slice(3)];

Copilot · 2026-02-09T23:16:18Z

docs/scripts/generateLlmTxt/typedocProcessor.mjs

+ * demoProcessor.mjs - Process demo component directories
+ *
+ * This module handles loading and converting demo code examples
+ * into markdown code blocks for documentation.


The file header comment appears copy/pasted from the demo processor and does not match this module’s purpose (it processes typedoc/types markdown). Update the header to reflect what this file does so future maintenance is less error-prone.

Suggested change

* demoProcessor.mjs - Process demo component directories

*

* This module handles loading and converting demo code examples

* into markdown code blocks for documentation.

* typedocProcessor.mjs - Process Typedoc types markdown

*

* This module resolves Typedoc components in MDX files to their generated

* types markdown, parses that markdown, and returns AST nodes to be

* inserted into the documentation.

Copilot · 2026-02-09T23:16:19Z

docs/next.config.mjs

+    config.module.rules.push({
+      test: /[/\\\\]types\.ts$/,
+      use: [
+        defaultLoaders.babel,
+        {
+          loader: '@mui/internal-docs-infra/pipeline/loadPrecomputedTypes',
+          options: { performance: { logging: true } },
+        },
+      ],
+    });


This webpack rule matches any file path ending in `types.ts`, which is very broad and can unintentionally apply the precomputed-types loader to unrelated `types.ts` modules. It would be safer to scope the rule to the intended directory/pattern (e.g., only under `docs/src/app/**/types.ts`) to prevent accidental loader application as the codebase grows.

docs/package.json

michaldudak · 2026-02-12T07:55:57Z

docs/src/app/(docs)/react/components/accordion/page.mdx

-<Reference component="Accordion" parts="Root, Item, Header, Trigger, Panel" />
+import { TypesAccordion } from './types';
+
+### Root


I see that the types.md file already has full content. Why do we need to add each section separately here?

dav-is added 3 commits October 7, 2025 15:32

Begin migration to new typegen infra

1e306e2

Merge branch 'master' into davis/improved-typegen

14db5db

Cleanup ReferenceTable component

704b792

dav-is added type: enhancement It’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature. scope: docs-infra Involves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305). labels Oct 7, 2025

Fix pnpm-lock.yaml

e0eb54d

dav-is added 9 commits October 7, 2025 16:46

Add checkbox types.md

a0b0f2d

Remove the need for side-effect imports

3fc5a2c

Merge branch 'master' into davis/improved-typegen

2cf9945

pnpm dedupe

6660fc0

Fix prettier loader error

8123df3

Get llms.txt working again

e26085c

pnpm dedupe

a5f9871

pnpm dedupe

79bb600

Fix watchDirectly

b17e696

Fix output

764ede3

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Oct 13, 2025

Merge branch 'master' into davis/improved-typegen

5a93694

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Oct 14, 2025

dav-is added 2 commits October 14, 2025 14:24

bump docs-infra

2a21ba4

Bump docs-infra

c0e52e3

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Oct 16, 2025

dav-is added 5 commits October 17, 2025 19:06

Move markdown rendering to build-time

7c1df77

Migrate all entrypoints

f411c66

Delete generated json files

a574b17

Remove old api-docs-builder

a049c36

prettier

7a6a572

dav-is added 5 commits January 30, 2026 22:56

Bump docs-infra

a93d02e

Cleanup types diff

e3a92c5

Add message to use new command

56fe77e

Update additional types styles

fd9c5d5

bump docs-infra

fa18f39

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 2, 2026

dav-is added 4 commits February 2, 2026 15:11

Improve types.md output

654a2e0

Improve types.ts format

650e82a

Update snapshot

c645cca

Merge branch 'master' into davis/improved-typegen

8aa3af6

github-actions bot added PR: out-of-date The pull request has merge conflicts and can't be merged. and removed PR: out-of-date The pull request has merge conflicts and can't be merged. labels Feb 2, 2026

Merge branch 'master' into davis/improved-typegen

869a2c2

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 9, 2026

dav-is added 2 commits February 9, 2026 12:13

bump docs-infra

700e28d

Bump docs-infra

72f707d

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 9, 2026

Merge branch 'master' into davis/improved-typegen

e27d1c5

github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 9, 2026

Bump docs-infra

e40637b

dav-is marked this pull request as ready for review February 9, 2026 22:50

dav-is requested review from atomiks, colmtuite and michaldudak as code owners February 9, 2026 22:50

dav-is requested a review from Copilot February 9, 2026 23:13

Copilot AI reviewed Feb 9, 2026

View reviewed changes

Merge branch 'master' into davis/improved-typegen

980d954

github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged. label Feb 11, 2026

michaldudak reviewed Feb 12, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[docs-infra] Migrate to @mui/internal-docs-infra Type Generation #2932

[docs-infra] Migrate to @mui/internal-docs-infra Type Generation #2932

dav-is commented Oct 7, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 7, 2025 •

edited

Loading

Uh oh!

mui-bot commented Oct 7, 2025 •

edited

Loading

Uh oh!

netlify bot commented Oct 9, 2025 •

edited

Loading

Uh oh!

greptile-apps bot commented Feb 9, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Uh oh!

michaldudak Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	return parseMarkdown(typesContent).splice(3);
	return [...result, ...parseMarkdown(typesContent).slice(3)];

- * demoProcessor.mjs - Process demo component directories
- *
- * This module handles loading and converting demo code examples
- * into markdown code blocks for documentation.
+ * typedocProcessor.mjs - Process Typedoc types markdown
+ *
+ * This module resolves Typedoc components in MDX files to their generated
+ * types markdown, parses that markdown, and returns AST nodes to be
+ * inserted into the documentation.

Uh oh!

[docs-infra] Migrate to @mui/internal-docs-infra Type Generation #2932

Are you sure you want to change the base?

[docs-infra] Migrate to @mui/internal-docs-infra Type Generation #2932

Conversation

dav-is commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Features

Uh oh!

pkg-pr-new bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mui-bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle size report

Uh oh!

netlify bot commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for base-ui ready!

Uh oh!

greptile-apps bot commented Feb 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michaldudak Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dav-is commented Oct 7, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 7, 2025 •

edited

Loading

mui-bot commented Oct 7, 2025 •

edited

Loading

netlify bot commented Oct 9, 2025 •

edited

Loading