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

[code-infra] Use @mui/docs where possible #3751

Merged
merged 7 commits into from
Jul 3, 2024
Merged

Conversation

LukasTy
Copy link
Member

@LukasTy LukasTy commented Jul 3, 2024

Related to mui/material-ui#42833.

Would allow dropping last re-exports of MarkdownElement, Link and HighlightedCode.

Also, ditch @mui/docs aliasing from monorepo as there is already a dependency with that name (related to mui/mui-x#13713).
We agreed to keep the alias to avoid potential problems with out-of-sync @mui/docs and @mui/monorepo.

@LukasTy LukasTy added core Infrastructure work going on behind the scenes scope: code-infra Specific to the core-infra product scope: docs-infra Specific to the docs-infra product labels Jul 3, 2024
@LukasTy LukasTy self-assigned this Jul 3, 2024
@@ -25,7 +25,7 @@
"@emotion/server": "11.11.0",
"@emotion/styled": "11.11.5",
"@mui/base": "5.0.0-beta.40",
"@mui/docs": "6.0.0-dev.240424162023-9968b4889d",
"@mui/docs": "6.0.0-alpha.13",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

import { SectionTitle } from '@mui/docs/SectionTitle'; probably worked only because of the present alias.
Bumped the dependency version where this component is exported.

@LukasTy LukasTy requested a review from a team July 3, 2024 12:12
@LukasTy LukasTy marked this pull request as ready for review July 3, 2024 12:14
@Janpot
Copy link
Member

Janpot commented Jul 3, 2024

The alias for @mui/docs was intential as there is still a high coupling between docs code and @mui/docs. Unless this unblocks a specific problem I would be inclined to keep it until all imports from @mui/monorepo/docs/... are removed from Toolpad/X docs

@Janpot Janpot merged commit 70cd1af into mui:master Jul 3, 2024
14 checks passed
@Janpot
Copy link
Member

Janpot commented Jul 3, 2024

Thank you 🙏

@LukasTy LukasTy deleted the use-mui-docs branch July 3, 2024 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes scope: code-infra Specific to the core-infra product scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants