chore: markdownlint --fix sweep (auto-fixable violations only) - #1245
Merged
Merged
Conversation
Mechanical auto-fixes only (blank lines around headings/fences/lists, trailing whitespace, hard tabs, consistent list markers, bare-URL wrapping, heading spacing/trailing punctuation). Violations drop from 2,612 to 590; the remainder needs human judgment (MD040 code-fence languages, single-title, emphasis-as-heading) and is left for follow-ups. - 1.architectures/ excluded: the retained LifecycleScripts trees stay byte-identical to what the HyperPod console consumes, and base-config is CODEOWNERS-gated. - Heading punctuation removal does not change GitHub anchors (the slugger strips punctuation), verified against all in-repo anchor links.
markdownlint's tab fix replaces each hard tab with a single space. For the tab-indented fenced blocks under ordered-list items here, that dropped the indentation below the 3 columns (marker width) CommonMark requires to keep a block inside a list item, splitting the numbered lists. Re-indent the fences and their content to exactly 3 spaces — the marker-width offset the GFM parser strips — so rendering and copy-paste match the pre-sweep state. Only file in the sweep with tab-indented fences.
dmvevents
added a commit
to dmvevents/awsome-distributed-ai
that referenced
this pull request
Sep 1, 2026
…/fences/lists) Conform the sample's README + benchmarks/README to the repo markdownlint ruleset, matching the repo-wide sweep in awslabs#1245. Whitespace-only: blank lines inserted around headings (MD022), fenced code blocks (MD031), and lists (MD032). Verified `git diff --ignore-blank-lines` is empty — zero content change. `markdownlint-cli2 examples/inference/vllm/deepep-v2-efa/**/*.md` reports 0 errors. Signed-off-by: Anton Alexander <dmvevents@gmail.com>
dmvevents
added a commit
to dmvevents/awsome-distributed-ai
that referenced
this pull request
Sep 2, 2026
Run the repo's documented markdown gate (`npx markdownlint-cli2`, root .markdownlint.jsonc) against the migrated folder. The files were already failing that gate before this branch touched them: - blanks-around headings/fences/lists (MD022/MD031/MD032) throughout the README and benchmarks/README — auto-fixed (27 fixes), same class as the repo-wide sweep in awslabs#1245. - README.md: an inline "libfabric #12591" issue-ref had wrapped so `#12591` started a line, which GitHub renders as an H1 mid-paragraph (MD025 multiple H1 + MD022 + MD026 trailing punctuation + MD001 heading-increment). Reflowed the wrap so the ref stays inline (matching the sibling `#1701`/`#1311` refs); fixes the render and clears all four rules. No content change beyond the reflow; `npx markdownlint-cli2` now exits clean. Signed-off-by: Anton Alexander <dmvevents@gmail.com>
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.
Purpose
Post-reorg cleanup promised in #1119: run
markdownlint-cli2 --fixonce so the linter becomes actionable for contributors (the config was right-sized in #1119; this clears the mechanical backlog).Changes
1.architectures/excluded — the retained LifecycleScripts trees stay byte-identical to what the HyperPod console consumes, andbase-configis CODEOWNERS-gated.Violations: 2,612 → 590 (remainder needs human judgment: code-fence languages, single-title, emphasis-as-heading — future follow-up).
Test Results
docs-only
Checklist
mainbranch.docs-only).