docs: fix relative links in README for PyPI rendering - #1899
docs: fix relative links in README for PyPI rendering#1899Pradeepbeleri wants to merge 5 commits into
Conversation
WalkthroughThe pull request replaces all relative documentation links in README.md with absolute GitHub URLs pointing to the main branch to fix PyPI rendering issues. A corresponding changelog entry documents this fix. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@Pradeepbeleri are you still working on this please? |
Signed-off-by: Pradeepbeleri <pradpie@gmail.com>
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
3c27f75 to
e0c9f8f
Compare
|
[commit-verification-bot]
View your commit verification status: Commits Tab. To achieve verified status, please read: Remember, you require a GPG key and each commit must be signed with: Thank you for contributing! From the Hiero Python SDK Team |
Replaced relative links in README with absolute URLs to fix rendering issues on PyPI. Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Updated the README to include Python version badge. Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
|
PR is stale and i butchered it trying to fix the conflicts |
Description
This PR updates the documentation links in the
README.mdto ensure they render correctly on the PyPI project page. Previously, hardcoded relative links worked perfectly on GitHub but resulted in broken 404 links when viewed on PyPI.Fixes #1869