Skip to content

Commit 0994c32

Browse files
authored
Merge pull request #62 from Consensys/update-lang
Minor update to wording in vale contrib doc
2 parents d37568b + f71db48 commit 0994c32

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/contribute/run-vale.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ view issues in real-time.
3131

3232
1. [Install Vale locally](https://vale.sh/docs/vale-cli/installation/#package-managers).
3333

34-
1. Checkout the repo containing our Vale settings:
34+
1. Clone the repo containing our Vale settings:
3535

3636
```bash
3737
git clone https://github.com/Consensys/docs-gha.git
@@ -44,10 +44,11 @@ view issues in real-time.
4444
export VALE_CONFIG_PATH="/Users/{user-name}/documentation/docs-gha/spelling/.vale.ini"
4545
```
4646

47-
:::note
48-
To persist the ENV variable across sessions you’ll need to add the above command it to the appropriate
49-
file. For example `~/.zshrc` (default shell in newer macOS versions).
50-
:::
47+
:::note
48+
To persist the `VALE_CONFIG_PATH` environment variable across sessions, you’ll need to add the above command to the
49+
appropriate shell configuration file. For example, on macOS, add it to ~/.zshrc (the default shell configuration
50+
file in recent versions of macOS).
51+
:::
5152

5253
1. Run the `vale` command in your terminal with the location of your file. For example:
5354

@@ -64,11 +65,11 @@ view issues in real-time.
6465
6566
### Use the VS Code integration
6667
67-
You must have the VS Code editor installed to use this integration.
68+
You must have the [Visual Studio (VS) Code](https://code.visualstudio.com) editor installed to use this integration.
6869
6970
1. [Install Vale locally](https://vale.sh/docs/vale-cli/installation/#package-managers).
7071
71-
1. Checkout the repo containing our Vale settings:
72+
1. Clone the repo containing our Vale settings:
7273
7374
```bash
7475
git clone https://github.com/Consensys/docs-gha.git
@@ -78,7 +79,7 @@ You must have the VS Code editor installed to use this integration.
7879
7980
1. In the settings for the Vale VS Code extension, set the location of the `.vale.ini` file, and
8081
enable the spell check. The `.vale.ini` file is located within the `spelling` directory in the
81-
`docs-gha` repo that you checked out.
82+
`docs-gha` repo that you cloned onto your local.
8283
8384
![VS Code extension settings](../assets/vs-code-ext.png)
8485

0 commit comments

Comments
 (0)