Draft
Conversation
Adds a new workflow that runs Super Linter markdown quality checks on all Markdown files in the repository and creates a prioritized GitHub issue report when violations are found. - workflows/markdown-linter.md: Adapted from gh-aw super-linter.md - docs/markdown-linter.md: Documentation page - README.md: Added entry under Code Improvement Workflows Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
needs to be tested |
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
1 participant
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.
Phase 1: Consistency Check
No consistency issues found this run:
./workflows/files have matching./docs/pages ✅Phase 2: New Workflow Proposal
Markdown Linter
Source:
github/gh-aw/.github/workflows/super-linter.mdWhy it's valuable: Documentation quality matters for any repository. Markdown files accumulate inconsistencies, broken formatting, and style violations over time. This workflow runs Super Linter on every Markdown file in the repository on a weekday schedule, then uses an AI agent to analyze the linter output, categorize violations by severity, and create a prioritized GitHub issue with clear fix suggestions. Maintainers get a clear, actionable view of documentation quality issues without needing to run tools locally.
Merge rate: The blog series documents the super-linter workflow as part of the code-quality toolset. The workflow pattern (scheduled linter + issue creation) is used broadly across the factory.
Generalization plan:
cookielabel (gh-aw internal label)VALIDATE_MARKDOWN: "true"withVALIDATE_ALL_CODEBASE: "false"— validates Markdown only, which is universally applicablenoop:safe output for the clean-markdown caseProposed name:
markdown-linterFiles Changed
workflows/markdown-linter.md— New workflow filedocs/markdown-linter.md— New docs pageREADME.md— Added entry to Code Improvement Workflows (by analysis) section