Skip to content

Commit

Permalink
[docs] Remove more traces of yarn (#3400)
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Potoms <[email protected]>
Co-authored-by: Jan Potoms <[email protected]>
  • Loading branch information
oliviertassinari and Janpot authored Apr 15, 2024
1 parent 95cadf1 commit 0dc2e18
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 26 deletions.
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ _If you're looking into contributing to the docs, follow the [instructions](#bui

### Running apps inside the monorepo (recommended)

This will use the local version of Toolpad Studio as built in the monorepo. This is recommended when your app is in a folder inside of the monorepo. You may even decide to temporarily move your app into the monorepo.
This uses the local version of Toolpad Studio as built in the mono-repository.
This is recommended when your app is in a folder inside of the mono-repository.
You may even decide to temporarily move your app into the mono-repository.

1. Install dependencies:

```bash
pnpm install
```

1. Run the build in watch mode
1. Run the built-in watch mode

```bash
pnpm dev
Expand All @@ -37,7 +39,8 @@ This will use the local version of Toolpad Studio as built in the monorepo. This
If your application has dependencies other than `@toolpad/studio`, you have to temporarily add it to the workspace:
1. update `pnpm-workspace.yaml` (in the workspace root, not in your app), add your app folder to `workspaces.packages`. For example `examples/qr-generator` which has a dependency on `qrcode` this would be:
1. update `pnpm-workspace.yaml` (in the workspace root, not in your app), add your app folder to `workspaces.packages`.
For example; `examples/qr-generator` which has a dependency on `qrcode` this would be:
```yaml
packages:
Expand Down
16 changes: 10 additions & 6 deletions docs/data/toolpad/core/introduction/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,31 @@ Run

<codeblock storageKey="package-manager">

```bash pnpm
pnpm dlx create-toolpad-app --core
```

```bash yarn
yarn create toolpad-app --core
```

```bash pnpm
pnpm dlx create-toolpad-app --core
```

</codeblock>

Follow the instructions of the CLI. After you conclude the installation process, change your working dir to the project and run
<codeblock storageKey="package-manager">

```bash pnpm
pnpm run dev
```bash npm
npm run dev
```

```bash yarn
yarn dev
```

```bash pnpm
pnpm dev
```

</codeblock>

Visit **http://localhost:3000/** in your browser to open the application
Expand Down
4 changes: 4 additions & 0 deletions docs/data/toolpad/studio/concepts/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ npm run build
yarn build
```

```bash pnpm
pnpm build
```

</codeblock>

## Start step
Expand Down
4 changes: 2 additions & 2 deletions docs/data/toolpad/studio/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ yarn dev
```

```bash pnpm
pnpm run dev
pnpm dev
```

</codeblock>
Expand Down Expand Up @@ -99,7 +99,7 @@ yarn toolpad-studio:dev
```

```bash pnpm
pnpm run toolpad-studio:dev
pnpm toolpad-studio:dev
```

</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion docs/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ export default withDocsInfra({

return map;
},
// Used to signal we run yarn build
// Used to signal we run pnpm build
...(process.env.NODE_ENV === 'production'
? {
output: 'export',
Expand Down
14 changes: 0 additions & 14 deletions render.yaml

This file was deleted.

0 comments on commit 0dc2e18

Please sign in to comment.