[code-infra] Ship docs markdown inside @mui/material package#48722
Draft
Janpot wants to merge 2 commits into
Draft
[code-infra] Ship docs markdown inside @mui/material package#48722Janpot wants to merge 2 commits into
Janpot wants to merge 2 commits into
Conversation
Deploy previewhttps://deploy-preview-48722--material-ui.netlify.app/ Bundle size
Check out the code infra dashboard for more information about this PR. |
Adds the generated documentation markdown into the published @mui/material tarball under a docs/ folder, so consumers can read it from node_modules/@mui/material/docs/. Built under the MUI_PUBLISH_DOCS flag so we can play with it in evaluations before committing to it. Claude-Session: https://claude.ai/code/session_01BLXRVBESKEsbPinmik3YpD
Janpot
force-pushed
the
ship-docs-in-package
branch
from
d16660b to
9499357
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the generated documentation markdown into the published
@mui/materialtarball under adocs/folder, so consumers can read it fromnode_modules/@mui/material/docs/.Mirrors the approach in mui/base-ui#4761. Built under a
MUI_PUBLISH_DOCSflag so it only runs duringrelease:build, leaving normal dev builds untouched, and so we can evaluate it before committing to it.A few material-ui-specific notes for reviewers:
docs/public/material-ui/**/*.mdinto@mui/material, so the existingllms.txt(a.txtwith absolute website URLs) is not shipped. Instead the LLM docs generator now also emits anindex.mdwith relative links, which gives the shippeddocs/folder a navigable, offline-usable entry point.release:buildis also run by thetest_bundle_size_monitorCI job, so that job will now generate docs too — consistent with how base-ui's sharedrelease:buildbehaves.https://claude.ai/code/session_01BLXRVBESKEsbPinmik3YpD