Skip to content

fix(ENG-12465): use absolute URLs for README images to fix npm display#28

Merged
hiskudin merged 2 commits intomainfrom
fix/readme-npm-image-paths-v2
Mar 26, 2026
Merged

fix(ENG-12465): use absolute URLs for README images to fix npm display#28
hiskudin merged 2 commits intomainfrom
fix/readme-npm-image-paths-v2

Conversation

@hiskudin
Copy link
Copy Markdown
Collaborator

Summary

  • Replaces relative image paths (assets/banner-*.svg, assets/demo-*.svg) with absolute raw.githubusercontent.com URLs
  • npm's markdown renderer has no base URL context so relative paths produce broken image tags; GitHub resolves them fine which masked the issue

Test plan

  • Verify images render on the npm package page after publish
  • Verify images still render correctly on GitHub

🤖 Generated with Claude Code

Relative paths (assets/banner-*.svg, assets/demo-*.svg) resolve
correctly on GitHub but break on npm's markdown renderer which has
no base URL context. Replaced with raw.githubusercontent.com URLs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 26, 2026 09:17
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@hiskudin hiskudin changed the title fix: use absolute URLs for README images to fix npm display fix(ENG-12465): use absolute URLs for README images to fix npm display Mar 26, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates README image references so they render correctly on npm, which doesn’t resolve relative asset paths in rendered markdown/HTML.

Changes:

  • Replace relative assets/*.svg paths with absolute raw.githubusercontent.com URLs for the banner images.
  • Replace relative assets/*.svg paths with absolute raw.githubusercontent.com URLs for the “How It Works” diagram.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

@glebedel glebedel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hiskudin hiskudin merged commit beeb2ef into main Mar 26, 2026
3 checks passed
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.

3 participants