Skip to content

Commit

Permalink
fix(repo): minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
waldronmatt committed Oct 15, 2023
1 parent 2be4db5 commit 31fbb97
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
8 changes: 3 additions & 5 deletions docs/repo/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

### NX

Follow the directions [here](https://nx.dev/nx-cloud/set-up) to set up an `nx` account.

Follow the directions [here](https://nx.dev/nx-cloud/account/access-tokens) to set up an `nx` access token.
Follow the directions [here](https://nx.dev/nx-cloud/set-up) to set up an `nx` account and [here](https://nx.dev/nx-cloud/account/access-tokens) to set up an `nx` access token.

Create an `nx-cloud.env` file with the following to enable cloud caching:

Expand All @@ -28,9 +26,9 @@ Enable read and write workflow permissions in your repo via `Settings` -> `Actio

### Renovate

Go to `Option` and activate at least `Allow auto-merge` and `Automatically delete head branches`
Go to `Option` and activate at least `Allow auto-merge` and `Automatically delete head branches`.

Go to `Branches` and add a branch protection rule for your `main` branch. Activate `Require status checks to pass before merging` and `Require branches to be up to date before merging`
Go to `Branches` and add a branch protection rule for your `main` branch. Activate `Require status checks to pass before merging` and `Require branches to be up to date before merging`.

## NX Distributed Caching

Expand Down
4 changes: 2 additions & 2 deletions docs/repo/WORKSPACE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ pnpm add -w [package-name]
Add a package as a dependency for another local package:

```bash
pnpm add react --filter vite-project --workspace
pnpm add react --filter vite-project
```

Add a **local** package as a development dependency for another local package:

```bash
pnpm add -D eslint-config-custom --filter vite-project --workspace
pnpm add -D eslint-config-custom --workspace --filter vite-project
```

## Remove Packages
Expand Down

0 comments on commit 31fbb97

Please sign in to comment.