Skip to content

chore: lint authored Markdown in pre-commit - #8

Merged
xeophon merged 1 commit into
mainfrom
chore/markdownlint-precommit
Aug 17, 2026
Merged

xeophon merged 1 commit into
mainfrom
chore/markdownlint-precommit

Conversation

@snimu

@snimu snimu commented Aug 17, 2026 •

Copy link
Copy Markdown
Collaborator

Ports the Markdown linting already merged in the private residency repo (RL-Residency/residency-environments#12):

  • markdownlint-cli2 (v0.23.1) as a pre-commit hook, scoped to authored Markdown: top-level *.md, .github/**/*.md, environments/<env>/README.md, and generators/**/*.md.
  • .markdownlint-cli2.yaml with the shared conventions (MD013 off, compact MD060 tables, a small MD033 allowlist, MD041 off for CLAUDE.md).
  • Auto-fixes for the existing files: blank lines around lists/fences in AGENTS.md, a text language on the Zen of Python fence, and a trailing newline in CLAUDE.md.

uv run pre-commit run --all-files passes.

Note

Add markdownlint-cli2 pre-commit hook for authored Markdown files

  • Adds a .markdownlint-cli2.yaml config that disables MD013 (line length), allows common HTML elements for MD033, sets MD060 to compact style, and disables MD041 for CLAUDE.md.
  • Adds markdownlint-cli2 at v0.23.1 to .pre-commit-config.yaml, scoped to top-level, .github/, environments/*/README.md, and generators/** Markdown files.
  • Fixes a minor lint violation in AGENTS.md by adding a blank line before a fenced code block and tagging it as text.

Macroscope summarized 4bb115a.


Note

Low Risk
Tooling and documentation-only changes; no runtime, auth, or data-path impact.

Overview
Adds markdownlint-cli2 (v0.23.1) to pre-commit, limited to authored Markdown: root *.md, .github/**/*.md, environments/<env>/README.md, and generators/**/*.md.

Introduces .markdownlint-cli2.yaml with shared rules: no line-length cap (MD013), compact tables (MD060), a small HTML allowlist for MD033, and MD041 disabled for CLAUDE.md.

Doc lint cleanups: AGENTS.md gets spacing around lists/fences and a text-tagged Zen of Python block; CLAUDE.md gets a trailing newline.

Reviewed by Cursor Bugbot for commit 4bb115a. Bugbot is set up for automated code reviews on this repo. Configure here.

@snimu
snimu marked this pull request as ready for review August 17, 2026 09:57
@snimu
snimu requested a review from a team as a code owner August 17, 2026 09:57
@xeophon
xeophon merged commit a992029 into main Aug 17, 2026
12 checks passed
@xeophon
xeophon deleted the chore/markdownlint-precommit branch August 17, 2026 10:10
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