-
-
Notifications
You must be signed in to change notification settings - Fork 273
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
Generate API docs for Toolpad Core #3536
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
}, | ||
], | ||
}, | ||
{ | ||
pathname: '/toolpad/core/components/filter-group', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing these but we can restore them back in the same way once we add more components, they might have been causing issues with the scripts.
children: [ | ||
{ | ||
pathname: '/toolpad/core/components/select-filter', | ||
title: 'Select', | ||
pathname: '/toolpad/core/react-dashboard-layout', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we should follow this react-...
naming pattern for pages, I saw all the other MUI libraries are doing it? But we can do it differently too.
@@ -49,6 +48,60 @@ const LogoContainer = styled('div')({ | |||
}, | |||
}); | |||
|
|||
function ToolpadLogo({ size = 40 }: { size?: number }) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved this component inside here as that's kind of how the scripts expect files to be organized, but it does take up a lot of lines...
Thanks! I removed an alias as it broke the demo formatter. |
Generate API docs for Toolpad Core - first the proptypes must be generated with
pnpm proptypes
and then API docs built withpnpm docs:build:api
.Restructured the documentation a bit kind of just to be more like the other MUI libraries I was taking the scripts from and what these scripts expect, but it's all for discussion of course!
API links from component pages are broken - if this PR looks good I think we can fix it here in the MUI monorepo: https://github.com/mui/material-ui/blob/next/packages/markdown/prepareMarkdown.js
API Page: https://deploy-preview-3536--mui-toolpad-docs.netlify.app/toolpad/core/api/app-provider/