Skip to content

Commit 549ce0a

Browse files
committed
chore: add buzhash, codecs, deduplication to pln-ignore.txt
1 parent 77dd841 commit 549ce0a

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

.github/styles/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Vale Styles
2+
3+
This directory contains Vale linting configuration for ipfs-docs.
4+
5+
## Spelling Rules
6+
7+
There are two spelling systems:
8+
9+
1. **`Vocab/ipfs-docs-vocab/accept.txt`** - General Vale vocabulary
10+
2. **`pln-ignore.txt`** - Custom ignore file for `docs/PLNSpelling.yml`
11+
12+
### Fixing PLNSpelling Errors
13+
14+
When CI fails with `[docs.PLNSpelling] Did you really mean 'word'?`:
15+
16+
1. Add the word to **`pln-ignore.txt`** (lowercase)
17+
2. Do NOT add to `Vocab/accept.txt` - that file is for other Vale rules
18+
19+
The `PLNSpelling.yml` rule explicitly references `pln-ignore.txt`:
20+
21+
```yaml
22+
extends: spelling
23+
ignore:
24+
- pln-ignore.txt
25+
```

.github/styles/pln-ignore.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ boolean
2727
Bootstrappers
2828
boxo
2929
browserify
30+
buzhash
3031
caddy
3132
Caddyfile
3233
callout
@@ -41,6 +42,7 @@ clis
4142
cmds
4243
cnames
4344
codec
45+
codecs
4446
codecov
4547
coinlist
4648
composable
@@ -56,6 +58,7 @@ dapps
5658
data('s)
5759
datastore
5860
deduplicate
61+
deduplication
5962
Denylist
6063
denylist
6164
dep

0 commit comments

Comments
 (0)