Configure markdownlint rules - #124
Conversation
Reviewer's GuideThis PR introduces a project-wide markdownlint configuration and applies automated formatting fixes across markdown documentation (code-fence normalization, list renumbering, blank-line cleanup) to align with the new rules. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary by CodeRabbit
WalkthroughUpdate markdownlint configuration with explicit per-rule settings and ignore patterns. Revise documentation to use footnote citations and British English. Apply minor spelling edits in AGENTS.md. No code, API, or runtime changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (3)
🧰 Additional context used📓 Path-based instructions (2)**/*.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
⚙️ CodeRabbit configuration file
Files:
docs/**/*.md📄 CodeRabbit inference engine (AGENTS.md)
Files:
🧠 Learnings (7)📚 Learning: 2025-08-03T14:59:07.928ZApplied to files:
📚 Learning: 2025-08-06T22:18:56.467ZApplied to files:
📚 Learning: 2025-09-10T19:19:36.866ZApplied to files:
📚 Learning: 2025-09-10T19:21:02.306ZApplied to files:
📚 Learning: 2025-09-01T00:48:47.120ZApplied to files:
📚 Learning: 2025-08-17T00:50:47.834ZApplied to files:
📚 Learning: 2025-09-04T17:39:23.811ZApplied to files:
🔍 Remote MCP RefSummary — additional facts to aid review
🔇 Additional comments (5)
Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Verify that comma-separated language tags in code fences (e.g., ```ini,toml) are supported by your markdown renderer; you may need to use a single language or separate fences instead.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Verify that comma-separated language tags in code fences (e.g., ```ini,toml) are supported by your markdown renderer; you may need to use a single language or separate fences instead.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/vk-end-to-end-testing-guide.md (3)
142-150: Correct dev-dependencies to match examples and simplify code fence info string.Add the predicates crate used in examples and use a single language hint to keep syntax highlighters happy.
-```ini,toml +```toml [dev-dependencies] assert_cmd = "2.0" insta = { version = "1.34", features = ["redactions"] } third-wheel = "0.6" tokio = { version = "1.0", features = ["full"] } serde_json = "1.0" tempfile = "3.8" +predicates = "3.1"--- `400-406`: **Eliminate first‑person pronoun per docs style guide.** Replace “our mock server” with “the mock server”. ```diff -... send its API requests to our mock server instead of the real GitHub API. +... send its API requests to the mock server instead of the real GitHub API.
1019-1115: Convert numbered “Works cited” to GitHub‑flavoured footnotes and update in‑text cites.The docs standard requires GFM footnotes; the current numeric bibliography with trailing numbers in prose violates this. Replace the numbered list with [^n] definitions and update in‑text references in order of appearance.
Example replacement pattern:
- In text: “... within the GitHub ecosystem.[^1]”
- At end of file:
[^1]: Canop/termimad — GitHub. Accessed 2025‑07‑20. https://github.com/Canop/termimad
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
.markdownlint-cli2.jsonc(1 hunks)docs/ortho-config-users-guide.md(1 hunks)docs/vk-end-to-end-testing-guide.md(3 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
docs/**/*.md: Use the markdown files within thedocs/directory as a knowledge base and source of truth for project requirements, dependency choices, and architectural decisions.
Proactively update the relevant file(s) in thedocs/directory to reflect the latest state when new decisions are made, requirements change, libraries are added/removed, or architectural patterns evolve.
Files:
docs/ortho-config-users-guide.mddocs/vk-end-to-end-testing-guide.md
**/*.md
📄 CodeRabbit inference engine (AGENTS.md)
**/*.md: Documentation must use en-GB-oxendict spelling and grammar, except for the naming of the "LICENSE" file.
Validate Markdown files usingmake markdownlint.
Runmake fmtafter any documentation changes to format all Markdown files and fix table markup.
Validate Mermaid diagrams in Markdown files by runningmake nixie.
Markdown paragraphs and bullet points must be wrapped at 80 columns.
Code blocks in Markdown must be wrapped at 120 columns.
Tables and headings in Markdown must not be wrapped.
Use dashes (-) for list bullets in Markdown.
Use GitHub-flavoured Markdown footnotes ([^1]) for references and footnotes.
Files:
docs/ortho-config-users-guide.mddocs/vk-end-to-end-testing-guide.md
⚙️ CodeRabbit configuration file
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
docs/ortho-config-users-guide.mddocs/vk-end-to-end-testing-guide.md
⏰ Context from checks skipped due to timeout of 120000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Sourcery review
- GitHub Check: build-test
🔇 Additional comments (3)
docs/ortho-config-users-guide.md (1)
247-259: Fix MD029 compliance of nested ordered list — LGTM.The nested list items are now correctly sequential (2–5) and align with MD029 "ordered" style.
.markdownlint-cli2.jsonc (1)
3-12: Align markdownlint rules with house style — LGTM.Rule settings match the documented standards (dash bullets, 80/120 wrapping, ordered lists).
docs/vk-end-to-end-testing-guide.md (1)
174-183: Use of ```text for directory tree — LGTM.The code fence language is explicit and satisfies MD040.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
@coderabbitai Have the following now been resolved?
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
6b7e267 to
62bd906
Compare
1 participant
Summary
Testing
mdformat-allmake fmtmake lintmake testmake markdownlintmake nixie(fails: "nixie: No such file or directory")https://chatgpt.com/codex/tasks/task_e_68c29aed96b88322bec95c1de7066384
Summary by Sourcery
Configure and enable markdownlint for the project and update markdown documentation to conform to the new linting rules.
Enhancements:
Documentation: