Skip to content

Fix Vale style: spell out ELK acronym on first use#3783

Closed
mintlify-development[bot] wants to merge 1 commit intomainfrom
vale-audit-1772056213
Closed

Fix Vale style: spell out ELK acronym on first use#3783
mintlify-development[bot] wants to merge 1 commit intomainfrom
vale-audit-1772056213

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Feb 25, 2026

Summary

Ran Vale style audit on MDX files modified in PR #3776. Fixed one auto-correctable issue and documented one item requiring human review.

Changes made

  • Moved the ELK acronym expansion to the heading where it first appears, following the Mintlify.Acronyms rule that acronyms should be spelled out on first use

Before: ## ELK layout support
After: ## ELK (Eclipse Layout Kernel) layout support

Issues requiring human review

Line Rule Severity Issue Suggested fix
82 Mintlify.Parens suggestion Parenthetical explanation (controls shown when diagram height exceeds 120px) Consider rewording to avoid parentheses, e.g., "When set, this overrides the default behavior of showing controls when the diagram height exceeds 120px."

The Parens rule flags parentheses usage as a suggestion since parentheses can break reading flow. This is a stylistic choice that needs human judgment on whether the parenthetical is necessary or could be reworded.


Note

Low Risk
Docs-only wording change with no impact to runtime behavior.

Overview
Updates the Mermaid docs to expand the ELK acronym on first use by renaming the section header to ELK (Eclipse Layout Kernel) layout support and shortening the intro sentence link text to just ELK.

Written by Cursor Bugbot for commit cf31064. This will update automatically on new commits. Configure here.

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.

2 participants