Skip to content

Commit 621a43a

Browse files
authored
Add vale instructions to README (#1290)
1 parent 507aaa0 commit 621a43a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,17 @@ For **all other changes**:
7272

7373
If you see something that is wrong or outdated in the documentation but don't know how to fix it, [file an issue](https://github.com/fern-api/docs/issues) or reach out to [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi).
7474

75+
#### Style checking with Vale
7576

77+
We use [Vale](https://vale.sh/docs) to automatically check documentation contributions for grammar, style consistency, and adherence to our writing guidelines.
7678

79+
Our Vale configuration includes:
80+
- The [Microsoft style guide](https://github.com/errata-ai/Microsoft) as a foundation
81+
- Custom rules tailored to Fern's documentation style and terminology
7782

83+
A GitHub Action runs Vale on every pull request, providing feedback on style issues before merging. To catch issues earlier in your workflow, set up Vale to run automatically on your machine when you commit:
84+
85+
1. Install pre-commit: `brew install pre-commit`
86+
2. Install the hook: `pre-commit install`
87+
88+
When you commit changes to `.mdx` files, Vale will automatically run and display any errors, warnings, or suggestions, but won't block your commit.

0 commit comments

Comments
 (0)