Commit 75d7c4c
committed
fix(vale): improve spelling and heading rules for Google style compliance
Spelling improvements:
- Exclude fenced code blocks (~code) and inline code (~raw) from checking
- Add filters for URL paths, full URLs, and shortcode attributes
- Prevents false positives on code syntax and API endpoints
Capitalization improvements:
- Add InfluxDB product exceptions (InfluxDB, InfluxQL, Telegraf, etc.)
- Add common technical acronyms (API, CLI, SQL, HTTP, JSON, etc.)
- Add cloud provider names (AWS, GCP, Azure, S3)
- Add link to Google style guide for sentence case headings
Aligns with Google Developer Documentation Style Guide:
https://developers.google.com/style/capitalization
https://claude.ai/code/session_0173AuWPoy6UXiatCMGz4W7h1 parent 9e845ce commit 75d7c4c
File tree
2 files changed
+72
-3
lines changed- .ci/vale/styles/InfluxDataDocs
2 files changed
+72
-3
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
3 | 4 | | |
4 | 5 | | |
5 | 6 | | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
9 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
10 | 67 | | |
11 | 68 | | |
12 | 69 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
4 | 8 | | |
| 9 | + | |
| 10 | + | |
5 | 11 | | |
6 | 12 | | |
7 | 13 | | |
| |||
10 | 16 | | |
11 | 17 | | |
12 | 18 | | |
13 | | - | |
| 19 | + | |
| 20 | + | |
14 | 21 | | |
15 | | - | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
0 commit comments