Skip to content

Commit 646cf5a

Browse files
committed
Improve documentation
1 parent ee8799e commit 646cf5a

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/spell-and-style-checking.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Note that we have only started using vale recently (May 2023), and have only use
88

99
Further note that we are not sure yet which documentation is best to keep here versus keeping it centrally in the [isc-styles][]. So we might consolidate this documentation at a later point.
1010

11-
## How to check **Learning Path** content using vale (locally)
11+
## Running the checks for the Learning Path content locally
1212

1313
To run the vale checks locally, you need to install:
1414

@@ -25,7 +25,7 @@ Then run vale on the files that you want to check, e.g.:
2525

2626
This will run the checks on all markdown and asciidoc files below the `/project-leader` folder.
2727

28-
Any issues found will be shown in the terminal and would look like this:
28+
Any issues found will be shown in the terminal like this:
2929

3030
```bash
3131
project-leader/outline.md
@@ -37,22 +37,24 @@ Any issues found will be shown in the terminal and would look like this:
3737
'consollidating'?
3838
```
3939

40-
## How to check new Learning Path content coming in via Pull Requests
40+
## Checking new Learning Path content coming in via Pull Requests
4141

4242
This happens automatically, using GitHub Actions and this workflow [vale.yml](.github/workflows/vale.yml).
4343

4444
Output looks like this:
4545

4646
![Screenshot 2023-08-02 at 22 41 08](https://github.com/InnerSourceCommons/InnerSourceLearningPath/assets/163029/8dda3c81-634c-48db-9a2f-3f216b717e97)
4747

48-
You should only have to adapt that workflow when adding entirely new sections to the Learning Path.
48+
Note that this highlighting will only be done for any issues found in lines that were changed in the given Pull Request. The idea here is that a contributor should only have to review style issues in the content that they have added themselves.
49+
50+
You should only have to adapt the GitHub Actions workflow in [vale.yml](.github/workflows/vale.yml) when adding entirely new sections to the Learning Path.
4951

5052
## How to add exceptions to the spell checker?
5153

5254
There may be times where the Learning Path wants to use spelling differently from what is defined in [isc-styles][]. (Note that we hope that this will be the exception, as otherwise it won't make sense to maintain the styles centrally).
5355

5456
To do so, add the exceptions that you want to make to [accept.txt](.github/vale/Vocab/Base/accept.txt) or [reject.txt](.github/vale/Vocab/Base/reject.txt)
5557

56-
TBD - I think this needs to be described in more detail
58+
TBD - I think this needs to be described in more detail. Especially when to add exceptions locally, and when to add them to the isc-styles repo.
5759

5860
[isc-styles]: https://github.com/InnerSourceCommons/isc-styles

0 commit comments

Comments
 (0)