Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .vale-ci.ini
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ MinAlertLevel = suggestion
[*.{md,mdx}]
BasedOnStyles = Temporal

; Explicitly enable a single Google rule without pulling in the whole Google
; style. Google.Latin flags Latin abbreviations (e.g., i.e.) in favor of
; "for example" / "that is".
Google.Latin = YES
; Explicitly enable a single Std rule without pulling in the rest of Std.
; Std.Abbreviations.Latin flags Latin abbreviations (e.g., i.e.) in favor of
; "for example" / "that is" — the same check as the old Google.Latin rule,
; extracted directly from it (see vale/styles/Std/Abbreviations/Latin.yml).
Std.Abbreviations.Latin = YES

; Only enable the high-confidence rules we want in CI.
; Temporal.terms (term-capitalization substitution) is disabled here because
Expand Down
42 changes: 16 additions & 26 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,25 @@ StylesPath = "vale/styles"

MinAlertLevel = suggestion

; Std is vendored (via `vale sync`) but not yet in BasedOnStyles below, so its
; rules don't run yet. It's Vale's new shared rule library (see
; https://vale.sh/blog/std) meant to de-duplicate rules Google/Microsoft both
; reimplement, e.g. Oxford comma, passive voice, sentence length. Adopting it
; to replace those overlapping rules is a deliberate follow-up, not done here.
Packages = Google, Microsoft, alex, Std
; Vale's shared rule library (see https://vale.sh/blog/std), covering the
; general prose checks that used to come from the Google/Microsoft/alex
; packages (Oxford comma, passive voice, sentence length, contractions,
; first-person, gendered pronouns/terms, etc).
Packages = Std
Vocab = Temporal

[*.{md,mdx}]
BasedOnStyles = Vale, Google, Microsoft, alex, Temporal

; these are already covered in Google which we prioritize
Microsoft.Contractions = NO
Microsoft.Headings = NO
Microsoft.Passive = NO
Microsoft.Spacing = NO
Microsoft.Semicolon = NO
Microsoft.GeneralURL = NO
Microsoft.We = NO

; we'll skip unlikely profanity.
alex.ProfanityUnlikely = NO

; Disagree with this one.
Google.Will = NO

; forked into temporal style
Microsoft.ComplexWords = NO
Google.WordList = NO
BasedOnStyles = Vale, Std, Temporal

; Match the sentence-length threshold the old Microsoft.SentenceLength rule
; used, rather than Std's stricter 25-word default.
Std.Readability.SentenceLength[max] = 30

; alex (dropped along with Google/Microsoft below) was the only package
; checking inclusive language and profanity — ableist terms, race/LGBTQ
; terminology, profanity blocklists, condescension. Std only has narrow
; gendered-pronoun/term rules, not a replacement for that coverage. This is a
; deliberate, known gap, not an oversight.

; These are reference docs whose headings are literal command/metric names
; (e.g. "## audit-log", "### --workflow_id"), not prose — sentence-case
Expand Down
6 changes: 4 additions & 2 deletions readme/STYLE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Temporal documentation style guidance

The content included in the Temporal information corpus follows the [Google developer documentation style guide](https://developers.google.com/style), with deference to the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) for issues left unanswered by Google.
In addition, we maintain a set of Temporal-specific style guidelines that override certain aspects of the Google and Microsoft guides.
The content included in the Temporal information corpus follows the [Google developer documentation style guide](https://developers.google.com/style) for tone and structure.
In addition, we maintain a set of Temporal-specific style guidelines that override certain aspects of the Google guide.

Vale enforces this in practice through [Std](https://vale.sh/blog/std), Vale's shared library of general-purpose prose rules, plus Temporal's own custom rules in `vale/styles/Temporal` — not by vendoring the Google or Microsoft style packages directly.

We recommend that you use the Vale extension for your IDE. Vale enables you to configure rule sets in its own configuration file, making it useful for defining Temporal's style guidelines.

Expand Down
9 changes: 0 additions & 9 deletions vale/styles/Google/AMPM.yml

This file was deleted.

64 changes: 0 additions & 64 deletions vale/styles/Google/Acronyms.yml

This file was deleted.

8 changes: 0 additions & 8 deletions vale/styles/Google/Colons.yml

This file was deleted.

30 changes: 0 additions & 30 deletions vale/styles/Google/Contractions.yml

This file was deleted.

9 changes: 0 additions & 9 deletions vale/styles/Google/DateFormat.yml

This file was deleted.

9 changes: 0 additions & 9 deletions vale/styles/Google/Ellipses.yml

This file was deleted.

13 changes: 0 additions & 13 deletions vale/styles/Google/EmDash.yml

This file was deleted.

12 changes: 0 additions & 12 deletions vale/styles/Google/Exclamation.yml

This file was deleted.

9 changes: 0 additions & 9 deletions vale/styles/Google/Gender.yml

This file was deleted.

43 changes: 0 additions & 43 deletions vale/styles/Google/GenderBias.yml

This file was deleted.

13 changes: 0 additions & 13 deletions vale/styles/Google/HeadingPunctuation.yml

This file was deleted.

29 changes: 0 additions & 29 deletions vale/styles/Google/Headings.yml

This file was deleted.

11 changes: 0 additions & 11 deletions vale/styles/Google/Latin.yml

This file was deleted.

14 changes: 0 additions & 14 deletions vale/styles/Google/LyHyphens.yml

This file was deleted.

12 changes: 0 additions & 12 deletions vale/styles/Google/OptionalPlurals.yml

This file was deleted.

7 changes: 0 additions & 7 deletions vale/styles/Google/Ordinal.yml

This file was deleted.

7 changes: 0 additions & 7 deletions vale/styles/Google/OxfordComma.yml

This file was deleted.

Loading