Skip to content

docs: pre-format Markdown for dprint markdown plugin 0.29.0 - #44

Merged
DevSecNinja merged 1 commit into
mainfrom
steward/dprint-markdown-0.29
Nov 17, 2026
Merged

DevSecNinja merged 1 commit into
mainfrom
steward/dprint-markdown-0.29

Conversation

@DevSecNinja

Copy link
Copy Markdown
Owner

Description

DevSecNinja/.github#561 makes Renovate update dprint plugin URLs. Its first update, markdown 0.21.1 → 0.29.0 (it clears the 14-day soak around 2026-11-20), would reformat files here and fail lint / dprint. This PR puts the affected files into a form that passes dprint check with both 0.21.1 (today's CI) and 0.29.0, so the plugin update PR goes green without manual work. Owner-approved (T125, option C).

Changes

  • README.md: HTML laid out the way 0.29.0 does it (long <img> attributes on separate lines, <p> content on its own line). 0.21.1 leaves HTML as written, so it accepts this.
  • specs/001-noteiq-capture/plan.md: a code span that was wrapped across two lines is joined onto one line.

Closes #43

Validation

  • With this repository's own dprint.json, dprint check passes for the changed files with markdown 0.21.1 and with 0.29.0. I checked this against a copy of every Markdown file in the repository, fetched through the GitHub API; nothing was cloned.
  • The commit is made with steward commit-files and signed by GitHub.

Reformat the files that dprint's markdown plugin 0.29.0 would change, into a
form that passes dprint check with both 0.21.1 and 0.29.0, so the Renovate
plugin update from DevSecNinja/.github#561 passes lint.

Refs #43

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are blocking approval of this documentation-formatting change.

No open issues 🎉

What changed in this PR

Pre-formats NoteIQ documentation for the planned dprint Markdown plugin update from 0.21.1 to 0.29.0, targeting compatibility with both versions without changing documentation content or application behavior.

Changes:

  • Expands README HTML attributes and paragraph content onto separate lines.
  • Joins the wrapped Clippy command into a single-line code span.

Review was static; dprint checks were not rerun.

File Description
specs/​001-noteiq-capture/​plan.md Keeps the Clippy command on one line for formatter compatibility.
README.md Adjusts HTML layout to match the newer formatter’s output.

Review effort: Balanced

@DevSecNinja
DevSecNinja merged commit ac833d1 into main Nov 17, 2026
28 checks passed
@DevSecNinja
DevSecNinja deleted the steward/dprint-markdown-0.29 branch November 17, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: pre-format Markdown for dprint markdown plugin 0.29.0

2 participants