chore(docs): apply Codacy markdownlint fixes#6284
Conversation
Apply Codacy code-quality patch across docs and instruction files: - MD022/MD032: blank lines surrounding headings and lists - MD034: wrap bare URLs in angle brackets (copilot-instructions.md) - MD026: strip trailing colons from some headings (requirements-start.md) Docs/.claude/.github only; no source or runtime changes.
There was a problem hiding this comment.
Code Review: chore(docs): apply Codacy markdownlint fixes
This is a clean, purely mechanical documentation improvement. All changes are consistent and correct.
Summary
The PR applies markdownlint rules uniformly across all documentation and markdown files:
-
Blank lines after headings — adds the required blank line between a heading and the following content, which improves rendering consistency across different markdown renderers.
-
Blank lines before lists — ensures lists are preceded by a blank line, preventing some renderers from treating list items as inline text rather than list elements.
-
Angle brackets for bare URLs in
copilot-instructions.md(e.g.https://tunit.dev→<https://tunit.dev>) — this is the correct markdownlint-compliant way to make bare URLs clickable in strict CommonMark mode. -
Removed trailing period from the CONTRIBUTING.md legal notice sentence — minor punctuation fix that also happens to be linter-required.
-
Added missing newlines at end of files — several files were missing a terminal newline, which is a common linter requirement and a POSIX convention.
No concerns
- No content changes — only whitespace, blank lines, and formatting.
- All changes follow established markdownlint conventions.
- The fixes are consistent across files.
This is good hygiene and safe to merge.
Not up to standards ⛔🔴 Issues
|
| Category | Results |
|---|---|
| CodeStyle | 2 minor |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
Applies the Codacy code-quality patch across documentation and instruction files.
Rules applied
copilot-instructions.md)requirements-start.md)Scope
Docs /
.claude/.githubonly — no source or runtime changes.Notes (patch applied verbatim, including its inconsistencies)
CONTRIBUTING.md: dropped trailing period on the Legal Notice line (cosmetic, not a lint rule).requirements-start.md: MD026 colon-strip applied toFull Workflow,Question Formats,Expert Questions (Phase 4),Metadata Structurebut notImportant Rules:/Phase Transitions:— Codacy was inconsistent.Expert Questions (Phase 4)had its colon stripped but no blank added before its code fence, so MD022 is still technically violated there.AnalyzerReleases.Shipped.mdfiles are parsed by the RS2000 release-tracking analyzer; existing####subheadings already build, and blank-line inserts are tolerated.