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

[WIP][docs] Update components header to include product #36936

Closed
wants to merge 7 commits into from

Conversation

mnajdova
Copy link
Member

@mnajdova mnajdova commented Apr 19, 2023

IMPORTANT NOTE: This is a temporary fix, until the documentation for all products support the tabs API.


As we are removing the Unstyled suffix in the Base UI's components, we need to add support for namespace in the components header in the markdown files, as otherwise we will have conflicts in the components, for e.g. Tabs from @mui/material and Tabs from @mui/base.

This is needed in scenarios where Material UI components show the API of a Base UI's components in some of the components pages. I've also updated the generation of the links that point to Base UI's component to follow the new structure. To make this work, I needed to copy some utils from @mui-internal/api-docs-builder (I couldn't import the utils directly from here in the @mui/markdown as it is a commonjs module, while the api-docs-utils is an ES module).

@mui-bot
Copy link

mui-bot commented Apr 19, 2023

Netlify deploy preview

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 8b2bf84

Signed-off-by: Marija Najdova <mnajdova@gmail.com>
@mnajdova
Copy link
Member Author

I am closing the issue, we should rather remove the links from the Material UI's docs about the unstyled API, as we already have a section that this component is supported in the Base UI package.

@mnajdova mnajdova closed this Apr 20, 2023
@zannager zannager added the docs Improvements or additions to the documentation label Dec 26, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants