Skip to content

Fix broken logo in README - #124

Merged
jfriedr merged 1 commit into
mainfrom
fix/readme-logo
Oct 27, 2026
Merged

jfriedr merged 1 commit into
mainfrom
fix/readme-logo

Conversation

@jfriedr

@jfriedr jfriedr commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The README header loads the logo from https://docs.goshippo.com/images/Logo.png, which has returned 404 since the old docs portal was removed from api-metadata-specs (#407, 2026-04-24). It shows as a broken image on GitHub and on the package registry page.
  • Adds the logo to the repo at .github/assets/shippo-logo.png (same hippo logo the docs site now serves at /images/logo.png) and points the README at it by absolute raw.githubusercontent.com URL, so it renders on GitHub and on registry pages (which resolve images by absolute URL) without depending on the docs site layout.
  • Updates the matching Table of Contents entry where the generated TOC includes the header.

The README header is outside Speakeasy's managed sections, so regeneration keeps this change. Registry pages pick it up with the next published release.

Test plan

  • check passes (README and asset only; no code changes)
  • After merge, the logo renders at the top of the README on GitHub

🤖 Generated with Claude Code

https://docs.goshippo.com/images/Logo.png has returned 404 since the old docs
portal was removed. Store the logo in the repo and link to it by absolute URL so
it renders on GitHub and on package registries.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jfriedr
jfriedr requested review from a team as code owners October 27, 2026 17:19
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
Tests Skipped Failures Errors Time
17 0 💤 0 ❌ 0 🔥 22.671 ⏱

@wyatt-shippo wyatt-shippo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

clever! lgtm

@jfriedr
jfriedr merged commit f30e811 into main Oct 27, 2026
6 checks passed
@jfriedr
jfriedr deleted the fix/readme-logo branch October 27, 2026 17:34
wyatt-shippo added a commit that referenced this pull request Oct 28, 2026
… this file)

#124 fixed README.md by hosting the logo in .github/assets, but README-PYPI.md,
which pyproject names as the package readme, still pointed at the dead
docs.goshippo.com/images/Logo.png. Use the same repo-hosted asset.
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.

2 participants