Skip to content

Clarify changelog description formatting - #7965

Open
lcawl wants to merge 3 commits into
elastic:mainfrom
lcawl:changelog-descriptions
Open

Clarify changelog description formatting#7965
lcawl wants to merge 3 commits into
elastic:mainfrom
lcawl:changelog-descriptions

Conversation

@lcawl

@lcawl lcawl commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Relates to elastic/elastic-docs-skills#122
Updates the changelog style guide with respect to the format of the description field.

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Cursor Grok 4.6

@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 warning, 1 suggestion found

⚠️ Warnings (1): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
contribute-docs/style-guide/formatting.md 596 Elastic.Spelling 'monospace' is a possible misspelling.
💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
contribute-docs/style-guide/formatting.md 609 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.

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.

@lcawl
lcawl marked this pull request as ready for review August 14, 2026 21:14
@lcawl
lcawl requested a review from a team as a code owner August 14, 2026 21:14
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