From 2a16d43d55cd0244978160052303415b92a2a52c Mon Sep 17 00:00:00 2001 From: waldronmatt Date: Sat, 4 Nov 2023 16:06:19 -0400 Subject: [PATCH] fix(docs): doc tweaks --- README.md | 4 ++-- docs/repo/ARCHITECTURE.md | 2 +- docs/repo/SETUP.md | 6 +++--- docs/repo/WORKSPACE.md | 10 ++++------ 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1ff25083..2503867c 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,11 @@ pnpm prepare ## Setup -Token setup and repository settings can be [found here](docs/repo/SETUP.md). +Repository setup can be [found here](docs/repo/SETUP.md). ## Getting Started -**Note**: Append `--no-cache` at the end of cached commands to disable nx cloud caching and append `--skip-nx-cache` to disable cache connection to `nx cloud`. Example: `npx nx run-many -t test --no-cache --skip-nx-cache` +**Note**: Append `--skip-nx-cache` to disable cache for a specific command. Example: `npx nx run-many -t test --skip-nx-cache` Commit changes using conventional changelog: diff --git a/docs/repo/ARCHITECTURE.md b/docs/repo/ARCHITECTURE.md index 9be2d6ca..bdd00f97 100644 --- a/docs/repo/ARCHITECTURE.md +++ b/docs/repo/ARCHITECTURE.md @@ -20,7 +20,7 @@ pnpm-workspace.yaml **`configs`** - Contains linters / configurations such as `eslint` / `tsconfig` shared across the monorepo -**`docs`** - Contains documentation for ui components and other documentation +**`docs`** - Contains documentation for ui components and workspace documentation **`packages`** - Contains utilities and tools published to `npm` that are used across the monorepo diff --git a/docs/repo/SETUP.md b/docs/repo/SETUP.md index b4899f04..1602ec6d 100644 --- a/docs/repo/SETUP.md +++ b/docs/repo/SETUP.md @@ -10,13 +10,13 @@ Create an `nx` account [here](https://cloud.nx.app/). Create an `NX_CLOUD_ACCESS_TOKEN` token [here](https://cloud.nx.app/) via `Settings` -> `Manage Tokens`. -Create an `nx-cloud.env` file at the project root to enable cloud caching: +Create an `nx-cloud.env` file at the project root to enable cloud caching locally: ```bash NX_CLOUD_ACCESS_TOKEN=your-token ``` -Set up `NX_CLOUD_ACCESS_TOKEN` via `Settings` -> `Secrets` -> `Actions` to enable cloud caching via GitHub Actions. +Set up `NX_CLOUD_ACCESS_TOKEN` in GitHub via `Settings` -> `Secrets` -> `Actions` to enable cloud caching via GitHub Actions. ## Lerna @@ -24,7 +24,7 @@ Create a `GH_TOKEN` with `read/write` access [here](https://github.com/settings/ Create an `NPM_TOKEN` [here](https://www.npmjs.com/login) as type `Automation` via the `Access Tokens` section to allow Lerna to publish packages. -Set up your `NPM_TOKEN` via `Settings` -> `Secrets` -> `Actions`. +Set up your `NPM_TOKEN` in GitHub via `Settings` -> `Secrets` -> `Actions`. ## Github diff --git a/docs/repo/WORKSPACE.md b/docs/repo/WORKSPACE.md index 04b6cc49..cf9ac8d2 100644 --- a/docs/repo/WORKSPACE.md +++ b/docs/repo/WORKSPACE.md @@ -1,7 +1,5 @@ # Workspace Commands -pnpm workspace commands - ## Add Packages Install dependecies to the root of the workspace: @@ -10,16 +8,16 @@ Install dependecies to the root of the workspace: pnpm add -w [package-name] ``` -Add a package as a dependency for another local package: +Add a package as a dependency for local package: ```bash pnpm add react --filter vite-project ``` -Add a **local** package as a development dependency for another local package: +Add a **local** package and another package as a development dependency for local package: ```bash -pnpm add -D eslint-config-custom --workspace --filter vite-project +pnpm add -D eslint-config-custom --workspace eslint --filter vite-project ``` ## Remove Packages @@ -32,7 +30,7 @@ pnpm remove eslint-config-custom --filter vite-project ## Run Commands -Install / run commands for a specific sub-package: +Install / run commands for a specific local package: ```bash pnpm dev --filter vite-project