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

Add Toolpad file schema reference to the docs #1940

Merged
merged 31 commits into from
May 10, 2023
Merged

Conversation

Janpot
Copy link
Member

@Janpot Janpot commented Apr 26, 2023

Generates documentation that describes the Toolpad configuration files

See https://deploy-preview-1940--mui-toolpad-docs.netlify.app/toolpad/schema-reference/

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 30, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 4, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 5, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 5, 2023
@Janpot Janpot marked this pull request as ready for review May 8, 2023 09:10
@Janpot Janpot requested a review from mnajdova May 8, 2023 09:11
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

For the types that are described below, like NameStringValuePair, would it be feasable to show them in a tooltip when hovering? It will help with not having to scroll back and forth.
image

Looks much better than the first iteration.

"description": "Parameters to pass to this query."
},
"mode": {
"type": "string",
Copy link
Member

Choose a reason for hiding this comment

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

Not related to this PR: This can probably be better typed.

Copy link
Member Author

@Janpot Janpot May 8, 2023

Choose a reason for hiding this comment

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

It has

                   "enum": [
                      "query",
                      "mutation"
                    ],

I'll improve this in the docs like:

Screenshot 2023-05-08 at 13 00 49

@Janpot
Copy link
Member Author

Janpot commented May 8, 2023

@mnajdova Added a tooltip.

Screen.Recording.2023-05-08.at.12.53.08.mov

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 9, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 9, 2023
@Janpot Janpot merged commit 9505f30 into mui:master May 10, 2023
@Janpot Janpot deleted the schema-docsd branch May 10, 2023 13:07
@Janpot Janpot mentioned this pull request May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants