Skip to content

chore: fix broken training documentation links#1737

Open
ParasSalonia wants to merge 4 commits intohiero-ledger:mainfrom
ParasSalonia:fix/broken-doc-links
Open

chore: fix broken training documentation links#1737
ParasSalonia wants to merge 4 commits intohiero-ledger:mainfrom
ParasSalonia:fix/broken-doc-links

Conversation

@ParasSalonia
Copy link
Contributor

Fixes #1707

  • This PR fixes broken documentation links in the SDK developer training files.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 7, 2026

Walkthrough

This PR corrects broken documentation links in SDK developer training files (query and setup), updates several relative and external link targets, and adds a changelog "Fixed" entry documenting the documentation fixes.

Changes

Cohort / File(s) Summary
Changelog Entry
CHANGELOG.md
Added a "Fixed" changelog entry for corrected documentation links; removed three chore lines and a stray empty line.
Query Documentation Links
docs/sdk_developers/training/query.md
Updated example links from ../../examples/... to ../../../examples/... to correct relative paths to example scripts.
Setup Documentation Links
docs/sdk_developers/training/setup/05_network_client_setup.md, docs/sdk_developers/training/setup/06_importing_hiero_files.md
Fixed "Extra Support" and reference links to use correct relative paths; replaced local Pylance doc link with an external VS Code Marketplace URL and adjusted examples/project structure link targets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: fix broken training documentation links' accurately and clearly summarizes the main change in the PR—correcting broken documentation links in SDK training files.
Description check ✅ Passed The description references issue #1707 and explains that the PR fixes broken documentation links in SDK developer training files, which directly relates to the changeset.
Linked Issues check ✅ Passed The PR correctly addresses all objectives from issue #1707: updated relative paths in docs/sdk_developers/training/query.md, fixed link in docs/sdk_developers/training/setup/05_network_client_setup.md, and fixed links in docs/sdk_developers/training/setup/06_importing_hiero_files.md.
Out of Scope Changes check ✅ Passed Changes are limited to the specified files and link corrections. The CHANGELOG.md entry documents a fix for broken documentation links without unrelated modifications.
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

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

@exploreriii exploreriii requested a review from a team February 7, 2026 09:01
@exploreriii exploreriii added the status: needs triage review PR needs a review from the triage team label Feb 7, 2026
Copy link
Contributor

@tech0priyanshu tech0priyanshu left a comment

Choose a reason for hiding this comment

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

Hi @ParasSalonia , thanks for the contribution! The link reference needs to be updated so that it redirects to the correct file.

@tech0priyanshu tech0priyanshu added status: needs developer revision PR has requested changes that the developer needs to implement and removed status: needs triage review PR needs a review from the triage team labels Feb 7, 2026
Signed-off-by: ParasSalonia <parassalonia22@gmail.com>
@github-actions
Copy link

github-actions bot commented Feb 7, 2026

Hi, this is MergeConflictBot.
Your pull request cannot be merged because it contains merge conflicts.

Please resolve these conflicts locally and push the changes.

Quick Fix for CHANGELOG.md Conflicts

If your conflict is only in CHANGELOG.md, you can resolve it easily using the GitHub web editor:

  1. Click on the "Resolve conflicts" button in the PR
  2. Accept both changes (keep both changelog entries)
  3. Click "Mark as resolved"
  4. Commit the merge

For all other merge conflicts, please read:

Thank you for contributing!

Copy link
Contributor

@exploreriii exploreriii left a comment

Choose a reason for hiding this comment

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

hi @ParasSalonia
This is great!

But your changelog has some mistakes

Please can you re-add line 253
https://github.com/hiero-ledger/hiero-sdk-python/pull/1737/changes

can you also delete the fixed section in line 255 as its duplicted

Then LGTM thank you

@exploreriii exploreriii marked this pull request as draft February 7, 2026 20:57
Signed-off-by: Paras Salonia <parassalonia22@gmail.com>
Updated maintainer guidelines and added new maintainer information.

Signed-off-by: Paras Salonia <parassalonia22@gmail.com>
@ParasSalonia ParasSalonia marked this pull request as ready for review February 8, 2026 09:44
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Copy link
Member

@parvninama parvninama left a comment

Choose a reason for hiding this comment

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

LGTM ,
Thank you for your contribution :)

@exploreriii exploreriii added status: awaiting merge and removed status: needs developer revision PR has requested changes that the developer needs to implement labels Feb 8, 2026
@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1737   +/-   ##
=======================================
  Coverage   93.25%   93.25%           
=======================================
  Files         141      141           
  Lines        9061     9061           
=======================================
  Hits         8450     8450           
  Misses        611      611           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Beginner]: Fix some broken links in query and set up

4 participants