Skip to content

docs: fix documentation relative links and normalize test file naming#1730

Open
achahid19 wants to merge 3 commits intohiero-ledger:mainfrom
achahid19:fix_docs
Open

docs: fix documentation relative links and normalize test file naming#1730
achahid19 wants to merge 3 commits intohiero-ledger:mainfrom
achahid19:fix_docs

Conversation

@achahid19
Copy link
Contributor

Description:

Fix broken documentation links and align test file references with repository conventions.

  • Remove non-existent sections from CONTRIBUTING.md table of contents
  • Fix relative links in testing.md
  • Rename test files from test_*.py to *_test.py
  • Convert Windows-style paths to Unix-style paths in documentation references
  • Fix path referencing the sdk_developers folder

Related issue(s):

Fixes #1706


Notes for reviewer:

This PR only updates documentation links, path formatting, and test file naming references. No functional code changes.


Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

Remove invalid TOC entries in CONTRIBUTING.md, fix relative paths in
testing.md, convert Windows paths to Unix format, and rename test files
to follow *_test.py naming convention.

Signed-off-by: achahid19 <anasks1999@gmail.com>
Signed-off-by: achahid19 <anasks1999@gmail.com>
@achahid19 achahid19 requested review from a team as code owners February 6, 2026 11:31
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 6, 2026

Walkthrough

Fixes broken documentation links and normalizes test file path references across docs; removes two outdated Table of Contents entries in CONTRIBUTING.md and adds a changelog entry documenting these documentation updates.

Changes

Cohort / File(s) Summary
Documentation Link Fixes
docs/sdk_developers/testing.md
Replaced Windows-style backslash paths with cross-platform relative paths, updated links to CONTRIBUTING.md and docs/sdk_developers/signing.md, and standardized example test file references and link formatting.
Changelog and TOC Updates
CHANGELOG.md, CONTRIBUTING.md
Added changelog entry describing the link/path fixes and removed two entries ("Community & Support" and "Common Issues") from the CONTRIBUTING.md table of contents.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The PR title clearly and concisely summarizes the main changes: fixing documentation relative links and normalizing test file naming conventions.
Description check ✅ Passed The PR description is directly related to the changeset, detailing the specific documentation and link fixes made, including removal of TOC entries, relative link corrections, path normalization, and test file naming alignment.
Linked Issues check ✅ Passed The PR successfully addresses all core objectives from issue #1706: removed non-existent sections from CONTRIBUTING.md TOC, fixed relative links and Windows-style paths in testing.md, and normalized test file references to repository conventions.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation and path references as specified in issue #1706; no functional code or unrelated modifications are present.
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.

@exploreriii exploreriii added the beginner Achievable by a fairly new comer that has already completed a couple of good first issues label Feb 6, 2026
@exploreriii exploreriii requested a review from a team February 6, 2026 13:56
@exploreriii exploreriii added status: needs triage review PR needs a review from the triage team and removed beginner Achievable by a fairly new comer that has already completed a couple of good first issues labels Feb 6, 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.

I checked the relative path, but I’m still getting a 404 for all testing.md

@tech0priyanshu
Copy link
Contributor

Thanks @achahid19 for taking the time and putting in the ef

@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 6, 2026
@achahid19
Copy link
Contributor Author

achahid19 commented Feb 6, 2026

Hi @tech0priyanshu
Locally all relative paths are working as expected. However, after testing them from the GitHub interface, none of them seem to point to the correct file paths. I also noticed that links on CONTRIBUTING.md that work on the main branch don’t resolve properly there either.
I’ll investigate this further tomorrow.

exploreriii
exploreriii previously approved these changes Feb 7, 2026
@exploreriii exploreriii dismissed their stale review February 7, 2026 00:04

will wait results tomorrow

@exploreriii exploreriii marked this pull request as draft February 7, 2026 00:04
@achahid19
Copy link
Contributor Author

achahid19 commented Feb 7, 2026

Hi @tech0priyanshu @exploreriii, I looked into the issue and here’s what I found:

The relative paths I added work correctly locally and when browsing my fork branch fix_docs However, in the Pull Request UI, GitHub doesn’t reliably resolve relative links for PRs coming from a fork, so the links lose their branch context and return 404 errors.

Since the referenced files already exist in the repository, would you prefer that I replace these with absolute links pointing to the main branch instead?

Let me know what approach you’d like me to follow.

@exploreriii exploreriii marked this pull request as ready for review February 7, 2026 21:01
@exploreriii exploreriii added status: awaiting merge and removed status: needs developer revision PR has requested changes that the developer needs to implement labels Feb 7, 2026
@codecov
Copy link

codecov bot commented Feb 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1730   +/-   ##
=======================================
  Coverage   93.24%   93.24%           
=======================================
  Files         141      141           
  Lines        9051     9051           
=======================================
  Hits         8440     8440           
  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 testing and query

3 participants