Generate API docs for Toolpad Core #3536
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
apedroferreira
commented
May 21, 2024
github-actions
bot
removed
the
PR: out-of-date
This comment was marked as resolved.
This comment was marked as resolved.
apedroferreira
commented
May 22, 2024
| }, | ||
| ], | ||
| }, | ||
| { | ||
| pathname: '/toolpad/core/components/filter-group', |
There was a problem hiding this comment.
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.
apedroferreira
commented
May 22, 2024
| children: [ | ||
| { | ||
| pathname: '/toolpad/core/components/select-filter', | ||
| title: 'Select', | ||
| pathname: '/toolpad/core/react-dashboard-layout', |
There was a problem hiding this comment.
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.
apedroferreira
commented
May 22, 2024
| @@ -49,6 +48,60 @@ const LogoContainer = styled('div')({ | |||
| }, | |||
| }); | |||
|
|
|||
| function ToolpadLogo({ size = 40 }: { size?: number }) { | |||
There was a problem hiding this comment.
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...
Janpot
approved these changes
May 23, 2024
|
Thanks! I removed an alias as it broke the demo formatter. |
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generate API docs for Toolpad Core - first the proptypes must be generated with
pnpm proptypesand 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/