[dmt] feat: add no-lang-key rule for documentation front matter#361
Merged
Conversation
ipaqsa
approved these changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a new no-lang-key rule to the documentation linter that checks markdown files in docs/ for the presence of a lang: key in YAML front matter. The rule parses the front matter block (between --- delimiters) and reports an error with the exact line number if lang: is found.
Why do we need it, and what problem does it solve?
The language of a documentation file is already determined by the file naming convention: .md for English and .ru.md for Russian. Having an additional lang: key in the YAML front matter is redundant and can lead to inconsistencies -- for example, a file named README.md (English) could have lang: ru in its front matter, or vice versa. This creates confusion for the documentation build system and for contributors.
This rule enforces a single source of truth for the document language (the file name suffix) and ensures that the lang field is removed from front matter across all module documentation.
Example