Repository navigation
chore: lint authored Markdown in pre-commit - #8
Merged
Merged
Conversation
snimu
marked this pull request as ready for review
August 17, 2026 09:57
xeophon
approved these changes
Aug 17, 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.
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, andgenerators/**/*.md..markdownlint-cli2.yamlwith the shared conventions (MD013off, compactMD060tables, a smallMD033allowlist,MD041off forCLAUDE.md).AGENTS.md, atextlanguage on the Zen of Python fence, and a trailing newline inCLAUDE.md.uv run pre-commit run --all-filespasses.Note
Add markdownlint-cli2 pre-commit hook for authored Markdown files
.markdownlint-cli2.yamlconfig that disables MD013 (line length), allows common HTML elements for MD033, sets MD060 to compact style, and disables MD041 forCLAUDE.md.markdownlint-cli2atv0.23.1to.pre-commit-config.yaml, scoped to top-level,.github/,environments/*/README.md, andgenerators/**Markdown files.AGENTS.mdby adding a blank line before a fenced code block and tagging it astext.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, andgenerators/**/*.md.Introduces
.markdownlint-cli2.yamlwith shared rules: no line-length cap (MD013), compact tables (MD060), a small HTML allowlist forMD033, andMD041disabled forCLAUDE.md.Doc lint cleanups:
AGENTS.mdgets spacing around lists/fences and atext-tagged Zen of Python block;CLAUDE.mdgets a trailing newline.Reviewed by Cursor Bugbot for commit 4bb115a. Bugbot is set up for automated code reviews on this repo. Configure here.