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

[api-docs-builder] Allow custom annotations #44707

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

vladmoroz
Copy link
Contributor

In Base UI docs, all component docs and its API reference are placed on the same page

This PR updates the docs builder so that instead of separate API and docs URLs...

image

...we can use custom annotations provided from where the docs builder script runs:

image

@vladmoroz vladmoroz requested review from michaldudak and a team December 9, 2024 21:51
@vladmoroz vladmoroz added the scope: docs-infra Specific to the docs-infra product label Dec 9, 2024
@mui-bot
Copy link

mui-bot commented Dec 9, 2024

Netlify deploy preview

https://deploy-preview-44707--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 1c567c8

@michaldudak
Copy link
Member

Is there a PR in Base UI that uses this code already?

@mnajdova
Copy link
Member

Probably this one: mui/base-ui#1015, not sure if it was updated locally only as I don't see bump on the package itself.

Copy link
Member

@michaldudak michaldudak left a comment

Choose a reason for hiding this comment

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

Yeah, ok, it seems to work well in Core as well as Base UI.

@vladmoroz vladmoroz merged commit 817470c into mui:master Dec 10, 2024
19 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants