-
-
Notifications
You must be signed in to change notification settings - Fork 204
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] Start Toolpad Core docs #3383
base: master
Are you sure you want to change the base?
Conversation
1. Run: | ||
|
||
```bash | ||
yarn create toolpad-app --tutorial my-first-project |
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.
Does it make sense to introduce a new flag for this? Perhaps we can add a tutorial example?
yarn create toolpad-app --tutorial my-first-project | |
yarn create toolpad-app --core --example tutorial |
2. Install the packages necessary for this example: | ||
|
||
```bash | ||
yarn add -S @mui/x-data-grid @mui/x-charts @mui/toolpad-data-csv |
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.
Would it make sense to already include them in the package.json of the tutorial template?
…i-toolpad into docs/toolpad-core-intro
|
||
<p class="description">Tutorial</p> | ||
|
||
## Steps to follow |
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.
Can we format the tutorial with sections, instead of a numbered list? That way we get navigation on the right.
Perhaps it makes sense to have two sections?
## bootstrapping the application
commands to get started
## creating a page
bootstrapping 1 page + making it appear in navigation
Then this is where is where we can continue with https://deploy-preview-3611--mui-toolpad-docs.netlify.app/toolpad/core/introduction/dashboard-tutorial/
…i-toolpad into docs/toolpad-core-intro
Closes [docs] Refine the
@toolpad/core
docs introduction section #3420Create an outline for the Introduction page: https://deploy-preview-3383--mui-toolpad-docs.netlify.app/toolpad/core/introduction/