fix(docs): correct profile README diagram image paths - #5
Merged
Conversation
The profile README lives in profile/ but the rendered diagrams are at the repository root under docs/diagrams/. GitHub resolves relative image paths against the README's directory, so the previous docs/diagrams/* paths resolved to profile/docs/diagrams/* and 404'd. Prefix ../ so they resolve to the repository root. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add scripts/check-readme-images.py, run from the diagrams workflow after rendering. It resolves every local image path the way GitHub does (relative to the Markdown file's directory) and fails when a target is missing — catching broken README diagram links before they 404 on the rendered page. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
Summary
The org profile README is at
profile/README.md, but the rendered diagrams live at the repository root underdocs/diagrams/. GitHub resolves relative image paths against the README's own directory, so the mergeddocs/diagrams/*.pngpaths resolved toprofile/docs/diagrams/*.pngand 404'd (diagrams didn't render on the org profile).Fix: prefix the four
<picture>paths with../so they resolve to the repository root.Verification
srcto…/raw/main/profile/<path>;…/raw/main/profile/../docs/diagrams/pipeline.pngreturns 200 (GitHub normalizes..).…/raw/main/docs/diagrams/pipeline.png(the actual file location) returns 200; the previous…/profile/docs/diagrams/…returned 404.Test Plan
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com