Skip to content

docs: use relative path for README pipeline image#1450

Merged
dimitri-yatsenko merged 1 commit intomasterfrom
docs/readme-pipeline-relative-path
May 5, 2026
Merged

docs: use relative path for README pipeline image#1450
dimitri-yatsenko merged 1 commit intomasterfrom
docs/readme-pipeline-relative-path

Conversation

@MilagrosMarin
Copy link
Copy Markdown
Contributor

Summary

  • Replaces the absolute raw.githubusercontent.com URL with a relative path (images/pipeline.png) for the pipeline illustration in the README.
  • Follow-up to docs: refresh README pipeline illustration #1448 — even though that PR refreshed images/pipeline.png, the rendered README on GitHub keeps serving the old image because GitHub camo caches the absolute raw URL aggressively.
  • Using a relative path lets GitHub serve the image directly from the current commit, so the refreshed illustration appears immediately and future updates render without cache hiccups.

Test plan

  • View the rendered README on this PR — confirm the new pipeline illustration (calcium-imaging vocabulary, rectangles for Manual/Lookup, ovals for Imported/Computed) displays correctly.
  • Confirm the image renders at the same size/position as before.

The absolute raw.githubusercontent.com URL is served via GitHub's camo
image proxy, which caches aggressively — so even after #1448 refreshed
images/pipeline.png, the rendered README kept showing the old image.

Switching to a relative path lets GitHub serve the image directly from
the current commit, so the new illustration appears immediately and
future updates to the file render without cache hiccups.
@MilagrosMarin MilagrosMarin marked this pull request as ready for review May 5, 2026 16:22
@dimitri-yatsenko dimitri-yatsenko merged commit ada2ee4 into master May 5, 2026
3 checks passed
@dimitri-yatsenko dimitri-yatsenko deleted the docs/readme-pipeline-relative-path branch May 5, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants