@@ -31,7 +31,7 @@ view issues in real-time.
31
31
32
32
1 . [ Install Vale locally] ( https://vale.sh/docs/vale-cli/installation/#package-managers ) .
33
33
34
- 1 . Checkout the repo containing our Vale settings:
34
+ 1 . Clone the repo containing our Vale settings:
35
35
36
36
``` bash
37
37
git clone https://github.com/Consensys/docs-gha.git
@@ -44,10 +44,11 @@ view issues in real-time.
44
44
export VALE_CONFIG_PATH=" /Users/{user-name}/documentation/docs-gha/spelling/.vale.ini"
45
45
```
46
46
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
+ :::
51
52
52
53
1. Run the ` vale` command in your terminal with the location of your file. For example:
53
54
@@ -64,11 +65,11 @@ view issues in real-time.
64
65
65
66
### Use the VS Code integration
66
67
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.
68
69
69
70
1. [Install Vale locally](https://vale.sh/docs/vale-cli/installation/#package-managers).
70
71
71
- 1. Checkout the repo containing our Vale settings:
72
+ 1. Clone the repo containing our Vale settings:
72
73
73
74
```bash
74
75
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.
78
79
79
80
1. In the settings for the Vale VS Code extension, set the location of the `.vale.ini` file, and
80
81
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 .
82
83
83
84

84
85
0 commit comments