Skip to content

fix: replace broken img tag with inline SVG for cli-layout diagram - #30327

Closed
alelpoan wants to merge 1 commit into
NousResearch:mainfrom
alelpoan:fix/cli-layout-inline-svg
Closed

fix: replace broken img tag with inline SVG for cli-layout diagram#30327
alelpoan wants to merge 1 commit into
NousResearch:mainfrom
alelpoan:fix/cli-layout-inline-svg

Conversation

@alelpoan

Copy link
Copy Markdown
Contributor

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/html instead of image/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

  • 🐛 Bug fix (non-breaking change that fixes an issue)

Changes Made

  • website/docs/user-guide/cli.md — replaced <img src="/img/docs/cli-layout.svg"> with inline SVG content

How to Test

  1. Run cd website && npm run start
  2. Open /docs/user-guide/cli in browser
  3. Scroll to "Interface Layout" section
  4. Confirm the Hermes CLI diagram renders correctly

Checklist

Code

  • I've read the Contributing Guide
  • My commit messages follow Conventional Commits
  • I searched for existing PRs to make sure this isn't a duplicate
  • My PR contains only changes related to this fix
  • I've run pytest tests/ -q and all tests pass — N/A
  • I've added tests for my changes — N/A
  • I've tested on my platform: Windows 11

Documentation & Housekeeping

  • I've updated relevant documentation — N/A
  • I've updated cli-config.yaml.example — N/A
  • I've updated CONTRIBUTING.md — N/A
  • I've considered cross-platform impact — N/A
  • I've updated tool descriptions/schemas — N/A

Screenshots / Logs

Before: broken image shown in Interface Layout section
image

After: Hermes CLI diagram renders correctly ✓
image

@alt-glitch alt-glitch added type/docs Documentation improvements P3 Low — cosmetic, nice to have labels May 22, 2026
@alt-glitch

Copy link
Copy Markdown
Collaborator

Related: #24824 (adds baseUrl prefix to SVG paths) and #27394 (fixes session-recap.svg + cli-layout.svg path). This PR takes a different approach by inlining the SVG entirely, bypassing the path/content-type issue.

@alelpoan

Copy link
Copy Markdown
Contributor Author

Related: #24824 (adds baseUrl prefix to SVG paths) and #27394 (fixes session-recap.svg + cli-layout.svg path). This PR takes a different approach by inlining the SVG entirely, bypassing the path/content-type issue.

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!

@teknium1

Copy link
Copy Markdown
Contributor

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!

@teknium1 teknium1 closed this May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low — cosmetic, nice to have type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants