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

[docs-infra] Show props in the table of content #38173

Merged
merged 5 commits into from
Aug 1, 2023

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Jul 26, 2023

Preview: https://deploy-preview-38173--material-ui.netlify.app/material-ui/api/button/

A follow up on #37405

Works on material

For @mui/base, the pipeline work but is not rendered because the ToC does not display at that depth (see here). The additional depth comes from the fact one page can contain multiple components

Could be nice to also add slots and CSS

image

@alexfauquette alexfauquette added the scope: docs-infra Specific to the docs-infra product label Jul 26, 2023
@mui-bot
Copy link

mui-bot commented Jul 26, 2023

Netlify deploy preview

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

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against aaecd6f

@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 27, 2023

does not display at that depth (see here).

The value of one docs page per exported API module 😁, I feel Option 3 is better UX: #36204.

@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label Jul 29, 2023
@alexfauquette alexfauquette mentioned this pull request Jul 31, 2023
1 task
Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Looking great, I'm sure it'll help a lot! 🤙

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 31, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 1, 2023
@alexfauquette alexfauquette merged commit 2d32d91 into mui:master Aug 1, 2023
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants