diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f739681e78e..411c2cc1056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,9 @@ _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: @@ -21,7 +23,7 @@ This will use the local version of Toolpad Studio as built in the monorepo. This pnpm install ``` -1. Run the build in watch mode +1. Run the built-in watch mode ```bash pnpm dev @@ -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: diff --git a/docs/data/toolpad/core/introduction/overview.md b/docs/data/toolpad/core/introduction/overview.md index ed79fd40a16..8ab9a14ed33 100644 --- a/docs/data/toolpad/core/introduction/overview.md +++ b/docs/data/toolpad/core/introduction/overview.md @@ -12,27 +12,31 @@ Run -```bash pnpm -pnpm dlx create-toolpad-app --core -``` - ```bash yarn yarn create toolpad-app --core ``` +```bash pnpm +pnpm dlx create-toolpad-app --core +``` + Follow the instructions of the CLI. After you conclude the installation process, change your working dir to the project and run -```bash pnpm -pnpm run dev +```bash npm +npm run dev ``` ```bash yarn yarn dev ``` +```bash pnpm +pnpm dev +``` + Visit **http://localhost:3000/** in your browser to open the application diff --git a/docs/data/toolpad/studio/concepts/deployment.md b/docs/data/toolpad/studio/concepts/deployment.md index fdd9a927bd4..6ad3c392bad 100644 --- a/docs/data/toolpad/studio/concepts/deployment.md +++ b/docs/data/toolpad/studio/concepts/deployment.md @@ -46,6 +46,10 @@ npm run build yarn build ``` +```bash pnpm +pnpm build +``` + ## Start step diff --git a/docs/data/toolpad/studio/getting-started/installation.md b/docs/data/toolpad/studio/getting-started/installation.md index 2919871b807..572b2dd0d60 100644 --- a/docs/data/toolpad/studio/getting-started/installation.md +++ b/docs/data/toolpad/studio/getting-started/installation.md @@ -46,7 +46,7 @@ yarn dev ``` ```bash pnpm -pnpm run dev +pnpm dev ``` @@ -99,7 +99,7 @@ yarn toolpad-studio:dev ``` ```bash pnpm -pnpm run toolpad-studio:dev +pnpm toolpad-studio:dev ``` diff --git a/docs/next.config.mjs b/docs/next.config.mjs index e6863e8b294..820a1d63319 100644 --- a/docs/next.config.mjs +++ b/docs/next.config.mjs @@ -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', diff --git a/render.yaml b/render.yaml deleted file mode 100644 index d8a8373c91a..00000000000 --- a/render.yaml +++ /dev/null @@ -1,14 +0,0 @@ -previewsExpireAfterDays: 3 - -services: - - type: web - name: npm-stats - env: node - rootDir: examples/npm-stats - buildCommand: yarn && yarn build - startCommand: yarn start - pullRequestPreviewsEnabled: true - plan: standard - envVars: - - key: NODE_VERSION - value: 18