Skip to content

docs: fix style guide violations in docs/reference subtree#608

Draft
alexandra5000 wants to merge 1 commit into
elastic:mainfrom
alexandra5000:style/docs-reference-style-fixes
Draft

docs: fix style guide violations in docs/reference subtree#608
alexandra5000 wants to merge 1 commit into
elastic:mainfrom
alexandra5000:style/docs-reference-style-fixes

Conversation

@alexandra5000

@alexandra5000 alexandra5000 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

TESTING THE docs-quality-sweep WORKFLOW

Summary

Style guide fixes across the docs/reference subtree (excluding edot-sdks/ which has a separate PR, and architecture image alt text which is deferred):

  • Remove temporal qualifiers: currently, not yet, would be → present tense
  • Replace marketing language: seamlessly, engineered for, robust and scalable mechanism, great experience, continuously → factual alternatives
  • Word order: also cancan also
  • Typo: receiveingreceiving
  • Missing commas: Oxford comma in one list; comma after introductory clause
  • Active voice: will be used/validated → present active; users canyou can
  • Menu path arrow: >
  • List marker normalization: * *
  • Imperative phrasing: Spin upSet up; Wait some timeAllow time
  • Removed (ACKs) verb shorthand in favor of spelled-out acknowledges

Files changed: index.md, central-configuration.md, architecture/k8s.md, compatibility/nomenclature.md, compatibility/limitations.md, motlp/index.md, motlp/troubleshooting.md, edot-cloud-forwarder/gcp/index.md

Test plan

  • Docs build passes
  • No meaning changes — purely style/grammar fixes

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 warning found

⚠️ Warnings (1): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
docs/reference/compatibility/limitations.md 85 Elastic.MenuArrows Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

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