Skip to content

Fix #501: Use absolute URL for STScI logo in README#549

Open
karlhillx wants to merge 1 commit into
spacetelescope:mainfrom
karlhillx:fix-501-remove-broken-logo
Open

Fix #501: Use absolute URL for STScI logo in README#549
karlhillx wants to merge 1 commit into
spacetelescope:mainfrom
karlhillx:fix-501-remove-broken-logo

Conversation

@karlhillx

@karlhillx karlhillx commented Jun 2, 2026

Copy link
Copy Markdown

The relative-path img tag (docs/_static/stsci_pri_combo_mark_white.png) renders on GitHub but breaks on PyPI. Switch to an absolute raw.githubusercontent.com URL so the brandmark displays on both.

Closes #501.

@karlhillx
karlhillx requested a review from a team as a code owner June 2, 2026 04:12
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 2, 2026
@zacharyburnett

Copy link
Copy Markdown
Collaborator

I'm hesitant to say that removing the brandmark entirely is the best solution here

@karlhillx

Copy link
Copy Markdown
Author

Fair enough. I can switch the image src to an absolute raw URL so the brandmark renders on PyPI too:
<img src="https://raw.githubusercontent.com/spacetelescope/stcal/main/docs/_static/stsci_pri_combo_mark_white.png" width="300"/>

Want me to pin to a commit SHA instead of main so old releases don't break retroactively? Either way, I can update the PR.

@zacharyburnett

Copy link
Copy Markdown
Collaborator

if we're going to point to a URL anyway then perhaps we should point to a central location

in general PyPI readme rendering is important so I'll bring it up with our upcoming templating work

@braingram
braingram marked this pull request as draft June 22, 2026 20:31
@karlhillx
karlhillx force-pushed the fix-501-remove-broken-logo branch from e124367 to 92990a0 Compare July 6, 2026 05:47
The relative path docs/_static/stsci_pri_combo_mark_white.png does not
render on PyPI. Switch to an absolute raw.githubusercontent.com URL so
the brandmark displays on both GitHub and PyPI.
@karlhillx
karlhillx force-pushed the fix-501-remove-broken-logo branch from 92990a0 to bd95198 Compare July 6, 2026 05:48
@karlhillx

Copy link
Copy Markdown
Author

Updated to keep the brandmark with an absolute raw.githubusercontent.com URL so it renders on PyPI too. If your templating work is going to centralize the logo URL anyway, happy to either land this as the interim fix or close in favor of that — your call.

@karlhillx
karlhillx marked this pull request as ready for review July 6, 2026 05:48
Copilot AI review requested due to automatic review settings July 6, 2026 05:48

Copilot AI 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.

Pull request overview

This PR addresses PyPI README rendering by changing the README logo reference so it no longer depends on a relative path that breaks on PyPI.

Changes:

  • Replaced the README logo <img> src from a relative path to an absolute raw.githubusercontent.com URL.

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

Comment thread README.md
@karlhillx karlhillx changed the title Fix #501: Remove broken logo from README Fix #501: Use absolute URL for STScI logo in README Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pypi shows broken image for rendered readme

3 participants