Skip to content

Add style guide to Contribute to the docs #139

Add style guide to Contribute to the docs

Add style guide to Contribute to the docs #139

Triggered via pull request November 24, 2025 21:38
Status Success
Total duration 46s
Artifacts 1

vale-linting.yml

on: pull_request
Fit to window
Zoom out
Zoom in

Annotations

10 warnings and 10 notices
vale: contribute-docs/style-guide/grammar-spelling.md#L315
Elastic.BritishSpellings: Use American English spelling 'authorize' instead of British English 'authorise'.
vale: contribute-docs/style-guide/grammar-spelling.md#L314
Elastic.BritishSpellings: Use American English spelling 'organize' instead of British English 'organise'.
vale: contribute-docs/style-guide/grammar-spelling.md#L300
Elastic.BritishSpellings: Use American English spelling 'visualization' instead of British English 'Visualisation'.
vale: contribute-docs/style-guide/grammar-spelling.md#L49
Elastic.Gender: Don't use 'he/she'.
vale: contribute-docs/style-guide/grammar-spelling.md#L40
Elastic.QuotesPunctuation: Put punctuation outside the quotation marks.
vale: contribute-docs/style-guide/formatting.md#L175
Elastic.EndPuntuaction: Don't end headings with punctuation
vale: contribute-docs/style-guide/accessibility.md#L231
Elastic.Latinisms: Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
vale: contribute-docs/style-guide/accessibility.md#L174
Elastic.QuotesPunctuation: Put punctuation outside the quotation marks.
vale: contribute-docs/style-guide/accessibility.md#L145
Elastic.EndPuntuaction: Don't end headings with punctuation
vale: contribute-docs/style-guide/accessibility.md#L133
Elastic.Accessibility: Don't use language (such as 'vision-impaired') that defines people by their disability.
vale: contribute-docs/style-guide/accessibility.md#L184
Elastic.WordChoice: Consider using 'can, might' instead of 'may', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L173
Elastic.Negations: Consider rephrasing to avoid negative constructions like 'cannot access the content without'. Try stating what something IS rather than what it is NOT.
vale: contribute-docs/style-guide/accessibility.md#L158
Elastic.WordChoice: Consider using 'efficient' instead of 'simple', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L133
Elastic.WordChoice: Consider using 'efficient' instead of 'easy', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L94
Elastic.WordChoice: Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'See', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L91
Elastic.DeviceAgnosticism: Use device-agnostic language when possible. Use 'select' instead of 'tap'.
vale: contribute-docs/style-guide/accessibility.md#L37
Elastic.WordChoice: Consider using 'efficient' instead of 'easy', unless the term is in the UI.
vale: contribute-docs/style-guide/accessibility.md#L8
Elastic.Acronyms: 'WCAG' has no definition.
vale: contribute-docs/good-issues.md#L73
Elastic.WordChoice: Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI.
vale: contribute-docs/good-issues.md#L17
Elastic.Wordiness: Consider using 'because' instead of 'since'.

Artifacts

Produced during runtime
Name Size Digest
vale-results Expired
4.34 KB
sha256:65ba77cafb664f3157a637fdfaf062ba7ceda99cf45c16811bd6c61871500c10