| name | PR Image Embedding |
| description | Embed images (benchmark charts, screenshots, diagrams) inline in a GitHub PR or issue description from an agent session, without bloating the code diff. Use when a PR needs visual evidence and you cannot drag-and-drop into the browser. |
PR Image Embedding
gaia is a private repo. That single fact drives every rule below, because
GitHub renders inline images through camo, its image proxy, and camo fetches
image URLs unauthenticated. Anything that needs a session or a token to fetch
will not render — it degrades to alt text that links to the source.
The flow
-
Generate the image locally. Write it somewhere outside the repo first
(the session scratchpad), so a rejected chart never lands in git history.
-
Look at it before you ship it. Read the PNG back with the Read tool.
Labels overlap, axes collide, and text clips constantly — a chart nobody
verified is worse than no chart, because reviewers trust it.
-
Commit the images to the single shared assets branch, pr-assets, under a
per-PR folder:
There is exactly one assets branch — pr-assets — and it is never
duplicated. Do not create a custom branch per PR. Every PR's images live
on pr-assets, each under its own folder named for the PR
(<pr-number>-<topic>/, e.g. 890-anydoc-parsing/). The branch already
exists and is cut from master; update it in place:
git fetch origin pr-assets
git checkout -B pr-assets origin/pr-assets
mkdir -p <pr-number>-<topic>
cp -f /path/to/charts/*.png <pr-number>-<topic>/
git add <pr-number>-<topic>/ && git commit -m
git push -u origin pr-assets
