📖🔧:restore the README's broken images - #898
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review. 📝 WalkthroughWalkthroughThe README now uses direct logo asset URLs, GitHub alert blockquotes for Note, Important, and Tip guidance, and expanded markdownlint suppression comments. ChangesREADME presentation updates
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The README updates restore logo paths and replace broken callout images with native GitHub alerts. No current merge-blocking risk is identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Some tools did not complete. Review the errors below. 🔧 markdownlint-cli2 (0.23.2)README.mdmarkdownlint-cli2 v0.23.2 (markdownlint v0.41.1) ... [truncated 1050 characters] ... Resolution (node:internal/modules/esm/resolve:271:11) Comment |
Every image at the top of this file was 404ing. The logo asked for /assets/img/svg/logogram-color.svg. The portal serves it from /assets/img/logogram-color.svg -- there is no `svg` segment -- so the organization's own mark has been a broken image icon. The three callouts were `<picture>` elements sourcing six SVGs from OpenINF/GitHub-Markdown, a repository that does not exist. They are hand-rolled versions of something GitHub renders natively now, so they become alerts: no external asset to rot, right in both colour schemes, and the remark configuration already allowed the syntax. Each alert is fenced with `<!-- prettier-ignore -->`, which is not decoration. prettier 3.9.6 under `proseWrap: always` corrupts a blockquote whose reference link straddles the wrap point: it appends a stray `>` inside the link text, turning `[Community Profile][]` into a reference that resolves to nothing. It is stable afterwards, so nothing puts it back, and no check in this repository would notice. Plain paragraphs are unaffected; blockquotes are not, alert or otherwise. The footer logo's existing disable comment also names `no-inline-html` now. Inline HTML is how this file lays itself out, so MD033 is off in .markdownlint.jsonc -- but Codacy lints markdown with its own configuration and counted the line as a new violation the moment its URL changed. Naming the rule in the document settles it for any runner. Verified by rendering the file through GitHub's own markdown API: three alerts, every image 200, and `Community Profile` still an anchor. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5
88f261d to
f4767c3
Compare
Every image at the top of this README was returning 404.
The logo
It asked for
/assets/img/svg/logogram-color.svg. The portal serves itfrom
/assets/img/logogram-color.svg— there is nosvgsegment — sothe organization's own mark has been rendering as a broken-image icon.
The three callouts
They were
<picture>elements sourcing six SVGs fromOpenINF/GitHub-Markdown— a repository that does not exist (theAPI 404s on it). They are hand-rolled versions of something GitHub
renders natively now, so they become
> [!NOTE],> [!IMPORTANT]and> [!TIP]: no external asset to rot, correct in both colour schemes,and
.remarkrc.mjsalready allowed the syntax.Why each alert is fenced with
<!-- prettier-ignore -->Not decoration. prettier 3.9.6 under
proseWrap: alwayscorrupts ablockquote whose reference link straddles the wrap point. It appends
a stray
>inside the link text:[Community Profile][]then resolves to nothing. Prettier is stableon the corrupted output, so it never puts it back, and no check here
would catch it — it is valid markdown, just a dead link.
It reproduces on a plain blockquote too, so this is not about alerts:
any blockquote in this repository with a reference link near the wrap
column is exposed. Plain paragraphs are unaffected. I have not fixed
prettier; the guard stops it touching the three blocks that would
trigger it.
Verification
Rendered the file through GitHub's own markdown API rather than
eyeballing it:
markdown-alert-note,-important,-tip)<img src>in the output returns 200Community Profileis still an<a>Wider than this repo
Code search says the broken logo path appears in 10 files across the
organization, and
OpenINF/GitHub-Markdownis referenced by 3(
openinf-util-text,docker-fisher, and this one). Out of scopehere — say the word and I will sweep them.
Summary by CodeRabbit