Skip to content

docs: co-locate screenshots with markdown#46

Merged
tito merged 1 commit intomainfrom
mathieu/docs-images
Apr 11, 2026
Merged

docs: co-locate screenshots with markdown#46
tito merged 1 commit intomainfrom
mathieu/docs-images

Conversation

@tito
Copy link
Copy Markdown
Contributor

@tito tito commented Apr 11, 2026

Summary

  • Adds screenshots for the dashboard, LLM conversations, credential substitution, and header redaction docs under docs/img/.
  • Updates the five referencing markdown files to use relative paths (./img/foo.png) instead of site-absolute paths.

Why

The previous sync (#main) brought in the markdown but referenced /img/greyproxy/foo.png, which only resolved on the docs site (where the PNGs were hand-placed under static/img/greyproxy/). Co-locating images with the markdown means:

  • The docs-sync workflow (rsync -a --delete docs/ → docs/docs/greyproxy/) carries the screenshots automatically. No workflow change needed.
  • GitHub renders the images correctly when browsing the markdown files in this repo.
  • Docusaurus only routes .md / .mdx, so PNGs in the same folder do not appear as doc pages.

Test plan

  • npx docusaurus build in the docs repo with the same layout (images at docs/docs/greyproxy/img/, relative refs) succeeds and pages render the screenshots.
  • After merge, manually trigger the docs-sync workflow (or wait for the next release) and confirm the docs site renders the images.

Add the dashboard, conversations, credentials, and header-redaction
screenshots under docs/img/ and reference them with relative paths
(./img/foo.png) so they render both on the docs site (after the
docs-sync workflow rsyncs docs/ into the docs repo) and when viewing
the markdown files directly on GitHub.
@tito tito merged commit 4801953 into main Apr 11, 2026
3 checks passed
@tito tito deleted the mathieu/docs-images branch April 11, 2026 02:11
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.

1 participant