You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
0 commit comments