Skip to content

Commit b5ccef1

Browse files
authored
Update Vale info in README (#1636)
1 parent 857a82e commit b5ccef1

File tree

1 file changed

+45
-13
lines changed

1 file changed

+45
-13
lines changed

README.md

Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -62,27 +62,59 @@ Keep the following principles in mind:
6262
6363
Our style guide is influenced by [Google's developer documentation style guide](https://developers.google.com/style) and Microsoft's [writing style guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
6464

65-
### Getting changes reviewed
65+
### Style checking with Vale
6666

67-
If you want to **add a new page or make a large structural change**:
68-
- [File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi). We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work.
67+
We use [Vale](https://vale.sh/docs) to check contributions for grammar, style consistency, and adherence to our writing guidelines. Our [Vale configuration](https://github.com/fern-api/docs/blob/main/.vale.ini) uses the [Microsoft style guide](https://github.com/errata-ai/Microsoft) plus custom rules for Fern's style and terminology.
6968

70-
For **all other changes**:
71-
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
69+
Vale runs automatically on PRs that modify `.mdx` files and comments with style suggestions (non-blocking).
70+
71+
<details>
72+
<summary>Style guidelines enforced by Vale</summary>
73+
74+
The Vale linter enforces the following style guidelines:
75+
76+
**Language and tone**
77+
- Avoid unnecessary adverbs (very, really, extremely, etc.) that don't add meaning
78+
- Don't use "please" in technical documentation
79+
- Use first person (I, me) sparingly
80+
- Avoid first-person plural (we, our, let's)
81+
- Write in an objective, instructional tone
82+
83+
**Time-relative language**
84+
- Avoid terms that become outdated: currently, presently, now, future, soon, latest, upcoming, old
85+
- Write documentation that remains accurate over time
7286

73-
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).
87+
**Headings**
88+
- Use sentence-case capitalization (capitalize only the first word and proper nouns)
89+
- Don't use end punctuation (periods, question marks, exclamation points)
7490

75-
#### Style checking with Vale
91+
**Acronyms**
92+
- Define acronyms on first use unless they're in the exceptions list (common technical acronyms like API, SDK, CLI, HTTP, JSON, etc.)
93+
- Format: "Application Programming Interface (API)"
7694

77-
We use [Vale](https://vale.sh/docs) to automatically check documentation contributions for grammar, style consistency, and adherence to our writing guidelines.
95+
**Terminology**
96+
- Use "Fern Editor" instead of "Visual Editor"
97+
- Use "API Reference" (capitalized) consistently
98+
- Use "API Explorer" (capitalized) consistently
7899

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
100+
**Formatting**
101+
- Don't hyphenate adverbs ending in -ly (e.g., "quickly moving" not "quickly-moving")
102+
</details>
82103

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:
104+
<details>
105+
<summary>Use Vale locally</summary>
106+
To catch issues earlier in your workflow, set up Vale to run automatically on your machine when you commit:
84107

85108
1. Install pre-commit: `brew install pre-commit`
86109
2. Install the hook: `pre-commit install`
110+
</details>
111+
112+
### Getting changes reviewed
113+
114+
If you want to **add a new page or make a large structural change**:
115+
- [File an issue in GitHub](https://github.com/fern-api/docs/issues) and assign [@devalog](https://github.com/devalog), [@kgowru](https://github.com/kgowru), or [@dsinghvi](https://github.com/dsinghvi). We'll review your issue to make sure your proposed page fits with Fern's overall documentation strategy and isn't duplicating any ongoing work.
116+
117+
For **all other changes**:
118+
- Submit a PR directly with your suggested changes. A Fern docs member will review and confirm.
87119

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.
120+
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).

0 commit comments

Comments
 (0)