ci: implement strict markdown linting pipeline and standardize docs#73
Merged
JacksonFergusonDev merged 2 commits intomainfrom Feb 22, 2026
Merged
ci: implement strict markdown linting pipeline and standardize docs#73JacksonFergusonDev merged 2 commits intomainfrom
JacksonFergusonDev merged 2 commits intomainfrom
Conversation
Introduced strict Markdown linting to enforce structural consistency and valid AST generation across all documentation.
- Added `.markdownlint.yaml` with project-specific overrides (disabling MD013 and MD033 to permit hard-wrapped lines and necessary inline HTML).
- Enforced MD004 (dash unordered lists) and MD029 ("one" style ordered lists) to minimize delta entropy in future diffs.
- Integrated `markdownlint-cli` into the GitHub Actions CI pipeline (`python-app.yml`).
- Appended `markdownlint-cli` to `.pre-commit-config.yaml` with the `--fix` argument to automate formatting resolution.
- Executed the auto-fix routine across all existing `.md` files to resolve trailing spaces, blank line constraints (MD031, MD032), and basic heading styles (MD003).
Refactored documentation to comply with linting rules requiring manual semantic intervention. - Converted sequential ordered lists (1., 2., 3.) to the uniform "one" style (1., 1., 1.) to satisfy MD029 and isolate future diff noise. - Standardized all unordered list delimiters to dashes to satisfy MD004. - Realigned heading hierarchies to ensure strict sequential incrementation (MD001), preventing anomalous AST jumps.
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.
Overview
This PR introduces a strict, deterministic Markdown linting pipeline to the repository. The objective is to enforce structural consistency across all documentation, ensure predictable Abstract Syntax Tree (AST) generation for rendering engines, and minimize Git diff entropy during routine documentation updates.
Changes Implemented
.markdownlint.yamlwith project-specific overrides.MD013(line length) andMD033(inline HTML) to support hard-wrapped text and custom visual components.MD029("one" style) for ordered lists to isolate delta noise during sequential refactoring.MD004("dash" style) for unordered lists.markdownlint-cliinto the GitHub Actions workflow (python-app.yml) to enforce compliance on all future PRs.markdownlint-clito.pre-commit-config.yamlwith the--fixflag to automatically resolve formatting deviations prior to commit..mdfiles into compliance with the new AST constraints (standardized list delimiters, resolved trailing whitespace, and fixed heading incrementation).Impact