Repository navigation
chore: add Markdown linting - #51
Merged
Merged
Conversation
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.
Summary
Add focused Markdown linting with
rumdlacross local development, pre-commit, and CI.Why
The repository is documentation-heavy, but its automated checks currently validate links rather than Markdown structure and consistency.
rumdladds a fast linting layer through the existing uv-based workflow without requiring Node.js or reformatting every document.Changes
rumdlas a locked development dependencyQuality checksjobType of change
Select the most relevant option.
Checklist
Verification
uv sync --locked --group devuv run pre-commit validate-configuv run pre-commit run --all-filesuv run ruff check .uv run ruff format --check .uv run rumdl check .uv run pytest --cov=text_toolkit --cov-report=term-missinguv run mypyuv build --no-sourcesgit diff --checkNotes
The existing pytest link check remains responsible for local paths and heading anchors. Human review remains responsible for accuracy, clarity, and teaching quality.