Skip to content

Conversation

@theletterf
Copy link
Contributor

@theletterf theletterf commented Nov 24, 2025

Summary

Brings the docs style guide and the good docs issues howto to the contribution section.

Fixes https://github.com/elastic/docs-content-internal/issues/339

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Tool(s) and model(s) used: Cursor with Claude Sonnet 4.5

@github-actions
Copy link

github-actions bot commented Nov 24, 2025

Vale Linting Results

Summary: 44 warnings, 143 suggestions found

⚠️ Warnings (44)
File Line Rule Message
contribute-docs/style-guide/accessibility.md 127 Elastic.Accessibility Don't use language (such as 'vision-impaired') that defines people by their disability.
contribute-docs/style-guide/accessibility.md 162 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/accessibility.md 218 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'using' instead of 'via'.
contribute-docs/style-guide/formatting.md 173 Elastic.EndPuntuaction Don't end headings with punctuation
contribute-docs/style-guide/grammar-spelling.md 40 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/grammar-spelling.md 49 Elastic.Gender Don't use 'he/she'.
contribute-docs/style-guide/grammar-spelling.md 303 Elastic.BritishSpellings Use American English spelling 'visualization' instead of British English 'Visualisation'.
contribute-docs/style-guide/grammar-spelling.md 317 Elastic.BritishSpellings Use American English spelling 'organize' instead of British English 'organise'.
contribute-docs/style-guide/grammar-spelling.md 318 Elastic.BritishSpellings Use American English spelling 'authorize' instead of British English 'authorise'.
contribute-docs/style-guide/grammar-spelling.md 319 Elastic.BritishSpellings Use American English spelling 'analyze' instead of British English 'analyse'.
contribute-docs/style-guide/grammar-spelling.md 327 Elastic.BritishSpellings Use American English spelling 'flavor' instead of British English 'flavour'.
contribute-docs/style-guide/grammar-spelling.md 328 Elastic.BritishSpellings Use American English spelling 'color' instead of British English 'colour'.
contribute-docs/style-guide/grammar-spelling.md 329 Elastic.BritishSpellings Use American English spelling 'behavior' instead of British English 'behaviour'.
contribute-docs/style-guide/grammar-spelling.md 337 Elastic.BritishSpellings Use American English spelling 'license' instead of British English 'licence'.
contribute-docs/style-guide/grammar-spelling.md 338 Elastic.BritishSpellings Use American English spelling 'defense' instead of British English 'defence'.
contribute-docs/style-guide/grammar-spelling.md 339 Elastic.BritishSpellings Use American English spelling 'pretense' instead of British English 'pretence'.
contribute-docs/style-guide/grammar-spelling.md 347 Elastic.BritishSpellings Use American English spelling 'dialog' instead of British English 'dialogue'.
contribute-docs/style-guide/grammar-spelling.md 348 Elastic.BritishSpellings Use American English spelling 'catalog' instead of British English 'catalogue'.
contribute-docs/style-guide/grammar-spelling.md 349 Elastic.BritishSpellings Use American English spelling 'epilog' instead of British English 'epilogue'.
contribute-docs/style-guide/seo.md 5 Elastic.DontUse Don't use 'just'.
contribute-docs/style-guide/seo.md 44 Elastic.DontUse Don't use 'very'.
contribute-docs/style-guide/seo.md 267 Elastic.MeaningfulCTAs Use meaningful link text. Use 'visit, go to, refer to' instead of 'click here'.
contribute-docs/style-guide/seo.md 356 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'.
contribute-docs/style-guide/ui-writing.md 30 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/ui-writing.md 33 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/ui-writing.md 70 Elastic.DontUse Don't use 'just'.
contribute-docs/style-guide/ui-writing.md 70 Elastic.DontUse Don't use 'just'.
contribute-docs/style-guide/ui-writing.md 98 Elastic.DontUse Don't use 'very'.
contribute-docs/style-guide/ui-writing.md 171 Elastic.DontUse Don't use 'just'.
contribute-docs/style-guide/ui-writing.md 171 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/ui-writing.md 263 Elastic.DontUse Don't use 'and/or'.
contribute-docs/style-guide/ui-writing.md 264 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/ui-writing.md 264 Elastic.QuotesPunctuation Put punctuation outside the quotation marks.
contribute-docs/style-guide/ui-writing.md 266 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'vs'.
contribute-docs/style-guide/voice-tone.md 31 Elastic.DontUse Don't use 'just'.
contribute-docs/style-guide/voice-tone.md 48 Elastic.DontUse Don't use 'very'.
contribute-docs/style-guide/voice-tone.md 49 Elastic.BritishSpellings Use American English spelling 'among' instead of British English 'amongst'.
contribute-docs/style-guide/voice-tone.md 303 Elastic.DontUse Don't use 'very'.
contribute-docs/style-guide/voice-tone.md 305 Elastic.DontUse Don't use 'Please'.
contribute-docs/style-guide/voice-tone.md 305 Elastic.DontUse Don't use 'please'.
contribute-docs/style-guide/voice-tone.md 305 Elastic.DontUse Don't use 'please'.
contribute-docs/style-guide/voice-tone.md 305 Elastic.EndPuntuaction Don't end headings with punctuation
contribute-docs/style-guide/voice-tone.md 307 Elastic.DontUse Don't use 'please'.
contribute-docs/style-guide/voice-tone.md 311 Elastic.DontUse Don't use 'Please'.
💡 Suggestions (143)
File Line Rule Message
contribute-docs/good-issues.md 17 Elastic.Wordiness Consider using 'because' instead of 'since'.
contribute-docs/good-issues.md 73 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.
contribute-docs/style-guide/accessibility.md 8 Elastic.Acronyms 'WCAG' has no definition.
contribute-docs/style-guide/accessibility.md 35 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 91 Elastic.DeviceAgnosticism Use device-agnostic language when possible. Use 'select' instead of 'tap'.
contribute-docs/style-guide/accessibility.md 94 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.
contribute-docs/style-guide/accessibility.md 127 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 150 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 162 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.
contribute-docs/style-guide/accessibility.md 170 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 172 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 182 Elastic.Wordiness Consider using 'because' instead of 'since'.
contribute-docs/style-guide/accessibility.md 190 Elastic.WordChoice Consider using 'can, might' instead of 'May', unless the term is in the UI.
contribute-docs/style-guide/accessibility.md 191 Elastic.Acronyms 'RFC' has no definition.
contribute-docs/style-guide/accessibility.md 227 Elastic.Wordiness Consider using 'impossible' instead of 'not possible'.
contribute-docs/style-guide/accessibility.md 229 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/accessibility.md 230 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/formatting.md 12 Elastic.Acronyms 'MDX' has no definition.
contribute-docs/style-guide/formatting.md 65 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.
contribute-docs/style-guide/formatting.md 96 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/formatting.md 122 Elastic.FutureTense 'you'll use' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/formatting.md 220 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/formatting.md 220 Elastic.WordChoice Consider using 'efficiently' instead of 'easily', unless the term is in the UI.
contribute-docs/style-guide/formatting.md 288 Elastic.FutureTense 'will help' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/formatting.md 288 Elastic.WordChoice Consider using 'efficiently' instead of 'easily', unless the term is in the UI.
contribute-docs/style-guide/formatting.md 428 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/formatting.md 444 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/grammar-spelling.md 12 Elastic.Wordiness Consider using 'to' instead of 'In order to'.
contribute-docs/style-guide/grammar-spelling.md 18 Elastic.Wordiness Consider using 'to' instead of 'In order to'.
contribute-docs/style-guide/grammar-spelling.md 20 Elastic.Wordiness Consider using 'because' instead of 'since'.
contribute-docs/style-guide/grammar-spelling.md 28 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.
contribute-docs/style-guide/grammar-spelling.md 35 Elastic.FirstPerson Avoid first-person pronouns such as ' I, '.
contribute-docs/style-guide/grammar-spelling.md 35 Elastic.FirstPerson Avoid first-person pronouns such as 'me'.
contribute-docs/style-guide/grammar-spelling.md 35 Elastic.FirstPerson Avoid first-person pronouns such as 'my'.
contribute-docs/style-guide/grammar-spelling.md 35 Elastic.FirstPerson Avoid first-person pronouns such as 'mine'.
contribute-docs/style-guide/grammar-spelling.md 40 Elastic.FirstPerson Avoid first-person pronouns such as 'my'.
contribute-docs/style-guide/grammar-spelling.md 45 Elastic.Wordiness Consider using 'because' instead of 'since'.
contribute-docs/style-guide/grammar-spelling.md 53 Elastic.FutureTense 'will and' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/grammar-spelling.md 53 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/grammar-spelling.md 53 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.
contribute-docs/style-guide/grammar-spelling.md 73 Elastic.FutureTense 'it'll,' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/grammar-spelling.md 91 Elastic.FutureTense 'will make' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/grammar-spelling.md 309 Elastic.FutureTense 'You'll find' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/grammar-spelling.md 378 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/index.md 19 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 1 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 3 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 3 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 7 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 11 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 15 Elastic.Capitalization 'H1: Primary page title' should use sentence-style capitalization.
contribute-docs/style-guide/seo.md 23 Elastic.FutureTense 'will learn' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 50 Elastic.FutureTense 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 55 Elastic.Capitalization 'H2: Secondary headings' should use sentence-style capitalization.
contribute-docs/style-guide/seo.md 95 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 95 Elastic.FutureTense 'will help' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 102 Elastic.FutureTense 'will learn' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 113 Elastic.Acronyms 'CTR' has no definition.
contribute-docs/style-guide/seo.md 123 Elastic.Versions Use 'and later' instead of 'and higher' when referring to versions.
contribute-docs/style-guide/seo.md 144 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 151 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/seo.md 202 Elastic.FutureTense 'will depend' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 210 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 214 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 261 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 294 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 304 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 336 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 338 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 369 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 370 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/seo.md 376 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 390 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 400 Elastic.Wordiness Consider using 'before' instead of 'Prior to'.
contribute-docs/style-guide/seo.md 401 Elastic.FutureTense 'will ignore' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/seo.md 417 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/seo.md 417 Elastic.DeviceAgnosticism Use device-agnostic language when possible. Use 'select' instead of 'tap'.
contribute-docs/style-guide/seo.md 427 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 429 Elastic.Acronyms 'SEO' has no definition.
contribute-docs/style-guide/seo.md 433 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
contribute-docs/style-guide/seo.md 435 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/seo.md 445 Elastic.Acronyms 'USA' has no definition.
contribute-docs/style-guide/seo.md 462 Elastic.Wordiness Consider using 'to' instead of 'in order to'.
contribute-docs/style-guide/ui-writing.md 11 Elastic.Acronyms 'EUI' has no definition.
contribute-docs/style-guide/ui-writing.md 32 Elastic.Wordiness Consider using 'remove' instead of 'Eliminate'.
contribute-docs/style-guide/ui-writing.md 44 Elastic.Acronyms 'EUI' has no definition.
contribute-docs/style-guide/ui-writing.md 69 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
contribute-docs/style-guide/ui-writing.md 70 Elastic.FirstPerson Avoid first-person pronouns such as ' I '.
contribute-docs/style-guide/ui-writing.md 86 Elastic.Acronyms 'RGB' has no definition.
contribute-docs/style-guide/ui-writing.md 111 Elastic.Acronyms 'APP' has no definition.
contribute-docs/style-guide/ui-writing.md 171 Elastic.Acronyms 'EUI' has no definition.
contribute-docs/style-guide/ui-writing.md 171 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/ui-writing.md 172 Elastic.Exclamation Use exclamation points sparingly. Consider removing the exclamation point.
contribute-docs/style-guide/ui-writing.md 173 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.
contribute-docs/style-guide/ui-writing.md 200 Elastic.Wordiness Consider using 'impossible' instead of 'not possible'.
contribute-docs/style-guide/ui-writing.md 244 Elastic.FutureTense 'you'll find' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/ui-writing.md 259 Elastic.WordChoice Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI.
contribute-docs/style-guide/ui-writing.md 263 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/ui-writing.md 276 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 18 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 18 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 29 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 29 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 40 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 40 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 44 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.
contribute-docs/style-guide/voice-tone.md 66 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 82 Elastic.FutureTense 'you'll see' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/voice-tone.md 82 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.
contribute-docs/style-guide/voice-tone.md 86 Elastic.Exclamation Use exclamation points sparingly. Consider removing the exclamation point.
contribute-docs/style-guide/voice-tone.md 95 Elastic.FutureTense 'we'll help' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/voice-tone.md 101 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 116 Elastic.Exclamation Use exclamation points sparingly. Consider removing the exclamation point.
contribute-docs/style-guide/voice-tone.md 156 Elastic.Wordiness Consider using 'all' instead of 'all of '.
contribute-docs/style-guide/voice-tone.md 176 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 189 Elastic.Acronyms 'ANN' has no definition.
contribute-docs/style-guide/voice-tone.md 191 Elastic.FutureTense 'will prevent' might be in future tense. Write in the present tense to describe the state of the product as it is now.
contribute-docs/style-guide/voice-tone.md 210 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 243 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 266 Elastic.WordChoice Consider using 'efficient' instead of 'easy', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 266 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 266 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 268 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.
contribute-docs/style-guide/voice-tone.md 274 Elastic.WordChoice Consider using 'efficient' instead of 'simple', unless the term is in the UI.
contribute-docs/style-guide/voice-tone.md 278 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 278 Elastic.Ellipses In general, don't use an ellipsis.
contribute-docs/style-guide/voice-tone.md 284 Elastic.Wordiness Consider using 'to' instead of 'in order to'.
contribute-docs/style-guide/voice-tone.md 285 Elastic.Wordiness Consider using 'if' instead of 'in the event that'.
contribute-docs/style-guide/voice-tone.md 286 Elastic.Wordiness Consider using 'use' instead of 'utilize'.
contribute-docs/style-guide/voice-tone.md 286 Elastic.Wordiness Consider using 'use' instead of 'make use of'.
contribute-docs/style-guide/voice-tone.md 287 Elastic.Wordiness Consider using 'tell' instead of 'inform'.
contribute-docs/style-guide/voice-tone.md 287 Elastic.Wordiness Consider using 'tell' instead of 'let know'.
contribute-docs/style-guide/voice-tone.md 288 Elastic.Wordiness Consider using 'also' instead of 'in addition'.
contribute-docs/style-guide/voice-tone.md 290 Elastic.Wordiness Consider using 'later' instead of 'at a later date'.
contribute-docs/style-guide/voice-tone.md 292 Elastic.Wordiness Consider using 'allows' instead of 'provides the opportunity'.
contribute-docs/style-guide/voice-tone.md 301 Elastic.Wordiness Consider using 'these' instead of 'All of these'.
contribute-docs/style-guide/voice-tone.md 305 Elastic.Exclamation Use exclamation points sparingly. Consider removing the exclamation point.
contribute-docs/style-guide/voice-tone.md 307 Elastic.Wordiness Consider using 'usually' instead of 'In most cases'.
contribute-docs/style-guide/voice-tone.md 319 Elastic.Wordiness Consider using 'because' instead of 'Since'.
contribute-docs/style-guide/voice-tone.md 320 Elastic.Wordiness Consider using 'when you' instead of 'The minute you'.
contribute-docs/style-guide/voice-tone.md 321 Elastic.Wordiness Consider using 'watch the following tutorial' instead of 'Watch the following clip'.
contribute-docs/style-guide/voice-tone.md 322 Elastic.Wordiness Consider using 'we recommend, we encourage' instead of 'Don't fall into the habit'.
contribute-docs/style-guide/voice-tone.md 338 Elastic.WordChoice Consider using 'efficiently' instead of 'easily', unless the term is in the UI.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

There are quite a few broken bullet points in the grammar page

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

I think there are some out-dated sections in the SEO gudelines

- [ ] URL matches the H1 & page focus
- [ ] Canonical tag is set to the preferred URL

**Meta keywords tag**
Copy link
Contributor

Choose a reason for hiding this comment

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

Meta keywords tag

Per previous comment, is this still supported and desired?

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

More broken bullets on the voice and tone page

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

More feedback on the UI writing page


You can adapt these patterns and the link to the search bar documentation to match your context and scenario.

## Naming
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@elastic/experience-docs These sections don't seem to have aged well. Could we review them? Keep them as is? Or delete them? +CC @lcawl

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.

3 participants