Skip to content

PDOCS-3680: align Vale rules with latest style guide updates#38

Merged
dfinn5-do merged 1 commit intomainfrom
style-guide-alignment-clean
Feb 3, 2026
Merged

PDOCS-3680: align Vale rules with latest style guide updates#38
dfinn5-do merged 1 commit intomainfrom
style-guide-alignment-clean

Conversation

@dfinn5-do
Copy link
Copy Markdown
Collaborator

Summary

Updates Vale rules to align with the latest DigitalOcean style guide changes.

Changes

Updated Rules (3)

  • ConsiderateWriting.yml: Added violent metaphors and idioms (kill/terminate, shoot/send, tribal knowledge, low-hanging fruit, white knight)
  • GenderBias.yml: Added hyphenated variants (man-hours) and workman/workwoman patterns
  • DigitalOceanTerms.yml: Added AI product terminology (Spaces, Model Playground, Agent Playground, Gradient AI Platform)

New Rules (8)

  • EmDashes.yml: Flag en dashes and em dashes (error level)
  • ExclamationMarks.yml: Warn about exclamation marks in technical docs (warning level)
  • RangeSpacing.yml: Flag spaces around hyphens in ranges (error level)
  • ModalAuxiliaries.yml: Warn about modal auxiliaries like should/could/may/might (warning level)
  • VagueLinkText.yml: Flag vague link text like "click here" (error level)
  • WordChoicePhrasalVerbs.yml: Enforce "log in to" not "log into" (error level)
  • Ellipses.yml: Warn about inappropriate ellipses usage (warning level)
  • LeadingZero.yml: Require leading zero for decimals less than 1 (error level)

Total Impact

  • Before: 21 DigitalOcean rules
  • After: 29 DigitalOcean rules (+38%)

Style Guide References

All changes map to specific sections in the updated product-docs style guide:

  • content/style/digitalocean/language/considerate-language.md
  • content/style/digitalocean/grammar/punctuation.md
  • content/style/digitalocean/grammar/hyphens.md
  • content/style/digitalocean/grammar/numbers.md
  • content/style/digitalocean/language/verbs.md
  • content/style/digitalocean/language/links-and-link-text.md
  • content/style/digitalocean/language/word-choice.md
  • content/style/digitalocean/products.md

Testing

Vale configuration validates successfully. Initial testing shows rules trigger correctly on target patterns.

Update existing rules and add new rules to match the latest DigitalOcean
style guide changes from product-docs.

Updated rules:
- ConsiderateWriting: add violent metaphors and idioms
- GenderBias: add hyphenated variants
- DigitalOceanTerms: add AI product terminology

New rules:
- EmDashes: flag en/em dashes
- ExclamationMarks: warn about exclamation marks
- RangeSpacing: flag spaces in ranges
- ModalAuxiliaries: warn about modal verbs
- VagueLinkText: flag vague link text
- WordChoicePhrasalVerbs: enforce phrasal verb usage
- Ellipses: warn about inappropriate ellipses
- LeadingZero: require leading zero in decimals

Total rules: 29 (was 21)
@dfinn5-do dfinn5-do requested a review from a team as a code owner February 3, 2026 14:15
@dfinn5-do dfinn5-do changed the title feat: align Vale rules with updated style guide PDOCS-3680: align Vale rules with latest style guide updates Feb 3, 2026
Copy link
Copy Markdown
Collaborator Author

@dfinn5-do dfinn5-do left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and working as intended.

@dfinn5-do dfinn5-do merged commit e512809 into main Feb 3, 2026
2 checks passed
@dfinn5-do dfinn5-do deleted the style-guide-alignment-clean branch February 3, 2026 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant