Repository navigation
docs: pre-format Markdown for dprint markdown plugin 0.29.0 - #44
Merged
Merged
Conversation
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
There was a problem hiding this comment.
🟢 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
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.
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 passesdprint checkwith 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
dprint.json,dprint checkpasses 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.steward commit-filesand signed by GitHub.