Skip to content

docs: fix relative links in README for PyPI rendering - #1899

Closed
Pradeepbeleri wants to merge 5 commits into
hiero-ledger:mainfrom
Pradeepbeleri:fix-readme-pypi-links
Closed

docs: fix relative links in README for PyPI rendering#1899
Pradeepbeleri wants to merge 5 commits into
hiero-ledger:mainfrom
Pradeepbeleri:fix-readme-pypi-links

Conversation

@Pradeepbeleri

Copy link
Copy Markdown
Contributor

Description

This PR updates the documentation links in the README.md to 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

@Pradeepbeleri
Pradeepbeleri requested a review from a team as a code owner March 2, 2026 17:07
@coderabbitai

coderabbitai Bot commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

The 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

Cohort / File(s) Summary
Changelog Update
CHANGELOG.md
Added entry under Fixed section documenting the replacement of relative documentation links with absolute GitHub URLs to resolve PyPI rendering issues.
Documentation Link Corrections
README.md
Replaced all relative documentation links (spanning Setup Guide, .env.example, Running Examples, Examples Directory, Contributing Guide, Windows Setup, Workflow, Signing, Changelog, Rebasing, Merge Conflicts, Typing, and Linting guides) with absolute GitHub URLs pointing to https://github.com/hiero-ledger/hiero-sdk-python/blob/main/... format across multiple sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: converting relative links in README to absolute GitHub URLs for PyPI rendering compatibility.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of updating documentation links from relative to absolute URLs for PyPI rendering.
Linked Issues check ✅ Passed The PR successfully addresses issue #1869 requirements: all relative links in README have been replaced with long-form GitHub URLs, and a CHANGELOG entry was added as required.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #1869: README link replacements and corresponding CHANGELOG entry; no extraneous modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 361d507 and 50dc5c3.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • README.md

Comment thread README.md Outdated
Comment thread README.md Outdated
@exploreriii

Copy link
Copy Markdown
Contributor

@Pradeepbeleri are you still working on this please?

Pradeepbeleri and others added 2 commits March 6, 2026 22:14
Signed-off-by: Pradeepbeleri <pradpie@gmail.com>
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
@exploreriii
exploreriii force-pushed the fix-readme-pypi-links branch from 3c27f75 to e0c9f8f Compare March 6, 2026 22:14
@github-actions

github-actions Bot commented Mar 6, 2026

Copy link
Copy Markdown

[commit-verification-bot]
Hi, this is VerificationBot.
Your pull request cannot be merged as it has 2 unverified commit(s):

  • 233b497 docs: fix relative links in README for PyPI render
  • e0c9f8f Fix link for Changelog Guide in README.md

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:
git commit -S -s -m "Your message here"

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>
@exploreriii

Copy link
Copy Markdown
Contributor

PR is stale and i butchered it trying to fix the conflicts
Sorry! Will have to try again

@exploreriii exploreriii closed this Mar 6, 2026
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.

[Beginner]: correct README to use long form links and not relative links

2 participants