Skip to content

Use absolute URL for logo in README - #11

Merged
glopesdev merged 1 commit into
mainfrom
fix-readme-absolute-logo-url
Aug 6, 2026
Merged

Use absolute URL for logo in README#11
glopesdev merged 1 commit into
mainfrom
fix-readme-absolute-logo-url

Conversation

@bruno-f-cruz

Copy link
Copy Markdown
Member

Changes the README logo source from a repo-relative path (docs/assets/logo.svg) to an absolute URL (https://raw.githubusercontent.com/harp-tech/pyharp/main/docs/assets/logo.svg).

The README is used as the long-description metadata for the PyPI package page. PyPI renders that description in isolation from the GitHub repo, so a repo-relative image path has no base to resolve against and evaluates to a broken link. Using an absolute raw.githubusercontent.com URL makes the image resolve correctly regardless of where the README is rendered (PyPI, GitHub, or elsewhere).

@glopesdev

Copy link
Copy Markdown
Contributor

@bruno-f-cruz Should we use a sha-pinned commit URL rather than a link to main? This way it might be easier to guarantee consistency and formatting even in case we ever refactor the repo structure or contents in the future.

@bruno-f-cruz
bruno-f-cruz force-pushed the fix-readme-absolute-logo-url branch from 9026a85 to 262fc0d Compare July 25, 2026 15:59
@bruno-f-cruz
bruno-f-cruz requested a review from glopesdev July 25, 2026 17:37
@glopesdev
glopesdev merged commit 626dba2 into main Aug 6, 2026
13 checks passed
@bruno-f-cruz
bruno-f-cruz deleted the fix-readme-absolute-logo-url branch August 25, 2026 22:55
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