fix: replace broken img tag with inline SVG for cli-layout diagram - #30327
fix: replace broken img tag with inline SVG for cli-layout diagram#30327alelpoan wants to merge 1 commit into
Conversation
Thanks for the context and for linking those PRs! Looks like there are a few approaches floating around for this. This one inlines the SVG directly, so it sidesteps the path/Content-Type issue entirely. Happy to defer to whatever approach the maintainers prefer, let me know if I should close or update anything! |
|
Superseded by #24824, which was merged to main as part of the Bucket-1 docs-correctness sweep (PR #34781). Your PR fixed the same issue — the SVG baseUrl image-path fix — and the merged version preserves per-commit authorship for the contributor whose variant was the most complete. Both contributors are credited. Thanks for catching this! |
What does this PR do?
The CLI Interface docs page shows a broken image in the "Interface Layout" section. The SVG file exists and the path is correct, but the server serves it with wrong Content-Type (
text/htmlinstead ofimage/svg+xml), causing browsers to refuse rendering it via<img>tag.This PR replaces the
<img>tag with inline SVG directly in the MDX file, bypassing the Content-Type issue entirely.Related Issue
Fixes #
Type of Change
Changes Made
website/docs/user-guide/cli.md— replaced<img src="/img/docs/cli-layout.svg">with inline SVG contentHow to Test
cd website && npm run start/docs/user-guide/cliin browserChecklist
Code
pytest tests/ -qand all tests pass — N/ADocumentation & Housekeeping
cli-config.yaml.example— N/ACONTRIBUTING.md— N/AScreenshots / Logs
Before: broken image shown in Interface Layout section

After: Hermes CLI diagram renders correctly ✓
