Skip to content

Rewrite readme to use URL instead of relative path to the logo - #5

Merged
rahlk merged 2 commits into
mainfrom
4-the-logo-on-pypi-is-broken
Jul 11, 2025
Merged

Rewrite readme to use URL instead of relative path to the logo#5
rahlk merged 2 commits into
mainfrom
4-the-logo-on-pypi-is-broken

Conversation

@rahlk

Copy link
Copy Markdown
Contributor

Fix logo rendering issue on PyPI by replacing relative image path with a raw GitHub URL in the README.

Motivation and Context

PyPI does not support relative image paths in README.md. The logo (./docs/assets/logo.png) failed to render on the project page. This fix ensures the logo displays correctly by pointing to the raw image URL on GitHub.

How Has This Been Tested?

  • Verified rendering locally via a Markdown preview
  • Uploaded the updated package to TestPyPI to confirm correct logo rendering

Breaking Changes

None

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the Codellm-Devkit Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

This change improves visual presentation and polish of the package on PyPI. Using raw GitHub URLs is a standard workaround for PyPI’s lack of support for relative paths in long descriptions.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
@rahlkrahlk self-assigned this Jul 11, 2025
@rahlkrahlk added the bug Something isn't working label Jul 11, 2025
@rahlkrahlk linked an issue Jul 11, 2025 that may be closed by this pull request
@rahlkrahlk added the documentation Improvements or additions to documentation label Jul 11, 2025
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
@rahlk
rahlk merged commit 4a33258 into mainJul 11, 2025
@rahlk
rahlk deleted the 4-the-logo-on-pypi-is-broken branch July 11, 2025 01:12
rahlk added a commit that referenced this pull request May 14, 2026
Rewrite readme to use URL instead of relative path to the logo
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The logo on pypi is broken

1 participant

@rahlk