Skip to content

Commit 2782f75

Browse files
committed
docs: improve readability of Vale documentation and clean up whitespace in workflow file
1 parent c0a315a commit 2782f75

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

.github/workflows/vale.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ jobs:
77
vale:
88
name: Vale Documentation Quality Check
99
runs-on: ubuntu-latest
10-
10+
1111
steps:
1212
- name: Checkout code
1313
uses: actions/checkout@v4
14-
14+
1515
- name: Run Vale
1616
uses: errata-ai/[email protected]
1717
with:

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@
1010

1111
### Documentation Quality with Vale
1212

13-
We use [Vale](https://vale.sh/) to maintain high-quality documentation standards. Vale checks your writing for clarity, consistency, and adherence to our style guidelines, helping us maintain a coherent tone of voice, accurate terminology, and overall editorial quality across the project.
13+
We use [Vale](https://vale.sh/) to maintain high-quality documentation
14+
standards. Vale checks your writing for clarity, consistency, and adherence to
15+
our style guidelines, helping us maintain a coherent tone of voice, accurate
16+
terminology, and overall editorial quality across the project.
1417

1518
#### Installing Vale
1619

@@ -50,7 +53,8 @@ vale --output=line src/
5053

5154
#### Vale Rules
5255

53-
Our Vale configuration uses the Google & Vale writing style guide, which helps ensure:
56+
Our Vale configuration uses the Google & Vale writing style guide, which helps
57+
ensure:
5458

5559
- Clear and concise language
5660
- Consistent terminology
@@ -188,7 +192,8 @@ Fork this repository and ensure you're working on the `main` branch:
188192
> you're satisfied with the preview
189193
> - All pull requests are reviewed by our team before being merged
190194
> - Feel free to ask questions in the pull request if you need clarification
191-
> - **Documentation Quality**: Vale will automatically check your documentation for style and clarity
195+
> - **Documentation Quality**: Vale will automatically check your documentation
196+
> for style and clarity
192197
193198
### Some conventions
194199

0 commit comments

Comments
 (0)