Skip to content

Commit a0d0ff0

Browse files
haleycodekodster28
andauthored
Hyperlint readme (#16483)
* Hyperlint readme * Update .hyperlint/README.md Co-authored-by: Kody Jackson <[email protected]> * Update .hyperlint/README.md Co-authored-by: Kody Jackson <[email protected]> * Update README.md * Update .hyperlint/README.md Co-authored-by: Kody Jackson <[email protected]> * Update README.md again --------- Co-authored-by: Kody Jackson <[email protected]>
1 parent 40130b7 commit a0d0ff0

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

.hyperlint/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Hyperlint
2+
3+
Hyperlint is a tool that enables us to automatically check if contributions to the docs adhere to our style guide. More info on how the tool works is available on the Hyperlint site: https://hyperlint.com/
4+
5+
#### Custom Vale rules
6+
We have several custom Vale rules that trigger Hyperlint suggestions located in our [custom Vale styles](https://github.com/cloudflare/cloudflare-docs/tree/production/.github/styles/cloudflare).
7+
8+
To report issues with them (or a new one entirely), open an issue in our repo.
9+
10+
#### Specific vocabularies
11+
12+
Instead of creating a long blocklist, we instead opted for an allowlist that can be expanded as use cases arise. New terms can be added to the allowlist file: .github/styles/config/vocabularies/cloudflare/accept.txt
13+
14+
If you resolve all Hyperlint comments, your PR checks will automatically pass. If the checks are especially noisy and unhelpful, add a `hyperlint-ignore` label to your PR and alert PCX to the flag.
15+

0 commit comments

Comments
 (0)