Skip to content

Commit 7314c2a

Browse files
committed
docs: add Vale documentation for quality checks and update .gitignore
1 parent ed80354 commit 7314c2a

File tree

4 files changed

+82
-0
lines changed

4 files changed

+82
-0
lines changed

.github/workflows/vale.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Documentation Quality
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
vale:
8+
name: Vale Documentation Quality Check
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v4
14+
15+
- name: Run Vale
16+
uses: errata-ai/[email protected]
17+
with:
18+
files: src/

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ components.d.ts
1212

1313
#mac
1414
.DS_Store
15+
16+
#vale
17+
.github/styles/*

.vale.ini

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
StylesPath = .github/styles
2+
MinAlertLevel = suggestion
3+
Packages = Google
4+
5+
[formats]
6+
md = markdown
7+
8+
[*.md]
9+
BasedOnStyles = Vale, Google
10+
IgnorePatterns = README.md

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,59 @@
44

55
- **Node.js**: Version 22 or higher
66
- **npm**: Comes bundled with Node.js
7+
- **Vale** (optional): For documentation linting and quality checks
78

89
## ⚙️ Configuration
910

11+
### Documentation Quality with Vale
12+
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.
14+
15+
#### Installing Vale
16+
17+
**macOS:**
18+
19+
```bash
20+
brew install Vale/tap/vale
21+
```
22+
23+
**Linux (Snap):**
24+
25+
```bash
26+
snap install vale
27+
```
28+
29+
**Windows:**
30+
31+
```bash
32+
choco install vale
33+
```
34+
35+
#### Running Vale Locally
36+
37+
```bash
38+
# Download and install external configuration sources
39+
vale sync
40+
41+
# Check all documentation files
42+
vale src/
43+
44+
# Check specific files
45+
vale src/get-started/helloWorld/1-overview.md
46+
47+
# Get detailed output
48+
vale --output=line src/
49+
```
50+
51+
#### Vale Rules
52+
53+
Our Vale configuration uses the Google & Vale writing style guide, which helps ensure:
54+
55+
- Clear and concise language
56+
- Consistent terminology
57+
- Professional tone
58+
- Accessibility best practices
59+
1060
### Environment Variables (Optional)
1161

1262
Some features of the application require environment variables. This
@@ -138,6 +188,7 @@ Fork this repository and ensure you're working on the `main` branch:
138188
> you're satisfied with the preview
139189
> - All pull requests are reviewed by our team before being merged
140190
> - 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
141192
142193
### Some conventions
143194

0 commit comments

Comments
 (0)