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

[docs] Start Toolpad Core docs #3383

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

bharatkashyap
Copy link
Member

@bharatkashyap bharatkashyap commented Apr 11, 2024

@bharatkashyap bharatkashyap added the docs Improvements or additions to the documentation label Apr 11, 2024
@bharatkashyap bharatkashyap changed the title docs: Start core docs docs: Start Toolpad Core `docs Apr 11, 2024
@bharatkashyap bharatkashyap changed the title docs: Start Toolpad Core `docs docs: Start Toolpad Core docs Apr 11, 2024
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Apr 15, 2024
@bharatkashyap bharatkashyap changed the title docs: Start Toolpad Core docs [docs] Start Toolpad Core docs Apr 18, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 14, 2024
@bharatkashyap bharatkashyap marked this pull request as ready for review May 14, 2024 11:03
1. Run:

```bash
yarn create toolpad-app --tutorial my-first-project
Copy link
Member

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?

Suggested change
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
Copy link
Member

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Refine the @toolpad/core docs introduction section
2 participants