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.

Sign up for GitHub

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] Improve outdated installation instructions #4633

Merged
merged 1 commit into from
Feb 12, 2025
Merged

[docs] Improve outdated installation instructions #4633

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 47 additions & 20 deletions docs/data/toolpad/core/introduction/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@

</codeblock>

2. Follow the instructions presented. Once the installation ends, run:
2. You will be asked to choose amongst your preferred frameworks (Next.js/Vite), routers and authentication providers. Once the installation ends, run:

Check warning on line 67 in docs/data/toolpad/core/introduction/installation.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/toolpad/core/introduction/installation.md", "range": {"start": {"line": 67, "column": 8}}}, "severity": "WARNING"}

<codeblock storageKey="package-manager">

Expand All @@ -87,28 +87,55 @@

3. Visit **http://localhost:3000/** in your browser to open the application.

4. The CLI bootstraps the following directory:
4. A sample directory structure with the Next.js App router will look like this:

Check failure on line 90 in docs/data/toolpad/core/introduction/installation.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.CorrectReferenceAllCases] Use 'App Router' instead of 'App router'

Raw Output:
{"message": "[MUI.CorrectReferenceAllCases] Use 'App Router' instead of 'App router'", "location": {"path": "docs/data/toolpad/core/introduction/installation.md", "range": {"start": {"line": 90, "column": 50}}}, "severity": "ERROR"}

Check warning on line 90 in docs/data/toolpad/core/introduction/installation.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/toolpad/core/introduction/installation.md", "range": {"start": {"line": 90, "column": 61}}}, "severity": "WARNING"}

```bash
├── app
│ ├── auth
│ ├──── [...path]
│ └────── page.tsx
│ ├── api
│ ├──── auth
│ ├────── [...nextAuth]
│ └───────── route.tsx
│ ├── (dashboard)
| ├──── layout.tsx
│ ├──── page
│ └────── page.tsx
├──── layout.tsx
└──── page.tsx
**Without Authentication:**

```bash
├── app
│ ├── (dashboard)
│ │ ├── layout.tsx
│ │ ├── page.tsx
│ │ └── orders
│ │ └── page.tsx
│ └── layout.tsx
├── .env
├── .env.local
├── .eslintrc.json
├── .gitignore
├── next.config.js
├── package.json
├── README.md
└── tsconfig.json
```

and the following page appears when you run the project locally:
**With Authentication:**

```bash
├── app
│ ├── auth
│ │ └── signin
│ │ └── page.tsx
│ ├── api
│ │ └── auth
│ │ └── [...nextauth]
│ │ └── route.ts
│ ├── (dashboard)
│ │ ├── layout.tsx
│ │ ├── page.tsx
│ │ └── orders
│ │ └── page.tsx
│ └── layout.tsx
├── .env
├── .env.local
├── .eslintrc.json
├── .gitignore
├── next.config.js
├── package.json
├── README.md
└── tsconfig.json
```

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/core/bootstrap.png", "srcDark": "/static/toolpad/docs/core/bootstrap-dark.png","alt": "Toolpad Core entry point", "caption": "Starting with Toolpad Core", "zoom": true, "indent": 1 }}
5. Installation is complete! Begin building your project by making edits to `(dashboard)/page.tsx`. To understand how to leverage Toolpad Core to build dashboards quickly, [see the detailed tutorial](/toolpad/core/introduction/tutorial/).

5. Installation is complete! Begin building your project by making edits to `(dashboard)/page/page.tsx`. To understand how to leverage Toolpad Core to build dashboards quickly, [see the detailed tutorial](/toolpad/core/introduction/tutorial/).
6. If you selected authentication, you will need to provide values to the `.env` files that have been created. See more information on the [usage with authentication libraries section](https://mui.com/toolpad/core/react-sign-in-page/#usage-with-authentication-libraries).

Check warning on line 141 in docs/data/toolpad/core/introduction/installation.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/data/toolpad/core/introduction/installation.md", "range": {"start": {"line": 141, "column": 40}}}, "severity": "WARNING"}
Loading