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

[joy-ui][docs] Fix API generation for Grid #39861

Merged
merged 2 commits into from
Nov 13, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Nov 12, 2023

This is a continuation of #39159.

I first saw the issue in https://app.ahrefs.com/site-audit/3992793/63/data-explorer?columns=pageRating%2Curl%2Ctraffic%2ChttpCode%2Cdepth%2Ccompliant%2CincomingAllLinks%2Corigin&filterId=91013c8aafad4fe1f7a0ad504eccad42&issueId=c64da643-d0f4-11e7-8ed1-001e67ed4656&sorting=-pageRating.

And a few days later, my friend flagged me the issue:

I was also curious to understand why we were not generating the API for the Grid component. After looking at it for 1/4 hour, it turned out that there were no real serious reasons, I had to fix a bit the API generator though.

Before: https://mui.com/joy-ui/react-box/#api
After: https://deploy-preview-39861--material-ui.netlify.app/joy-ui/react-box/#api

@oliviertassinari oliviertassinari added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Nov 12, 2023

mkdirSync(componentInfo.apiPagesDirectory, { mode: 0o777, recursive: true });

return generateComponentApi(componentInfo, project, projectSettings);
return await generateComponentApi(componentInfo, project, projectSettings);
Copy link
Member Author

Choose a reason for hiding this comment

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

Missing for a clear error message

@mui-bot
Copy link

mui-bot commented Nov 12, 2023

I was curious to understand why we were not generating the API for the Grid component.
After looking at it for 1/4 hour, it turned out that there was no real serious reasons.
Signed-off-by: Olivier Tassinari <olivier.tassinari@gmail.com>
@oliviertassinari oliviertassinari merged commit 2bb5c38 into mui:master Nov 13, 2023
9 of 12 checks passed
@oliviertassinari oliviertassinari deleted the joy-add-grid-api branch November 13, 2023 01:11
@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work regression A bug, but worse and removed regression A bug, but worse labels Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants