Skip to content

docs: fix broken markdown links and add lychee config#2114

Merged
exploreriii merged 2 commits into
hiero-ledger:mainfrom
tannaya7:fix/broken-markdown-links
Apr 16, 2026
Merged

docs: fix broken markdown links and add lychee config#2114
exploreriii merged 2 commits into
hiero-ledger:mainfrom
tannaya7:fix/broken-markdown-links

Conversation

@tannaya7

@tannaya7 tannaya7 commented Apr 12, 2026

Copy link
Copy Markdown
Contributor

Description:
Fixed broken markdown links detected by the scheduled link checker. Changes include:

  • Fixed truncated Discord channel ID in docs/discord.md by removing the invalid deep link
  • Fixed diff markers (merge artifacts) in docs/sdk_developers/training/network_and_client.md
  • Created .lychee.toml configuration file to exclude intentional placeholder URLs from link checking
  • Updated .github/workflows/cron-check-broken-links.yml to reference the new config file

Related issue(s):

Fixes #2050

Notes for reviewer:

  • rebasing.md fix was not needed as the file no longer exists in the repo
  • Discord channel deep link was removed as the correct 18-19 digit snowflake ID could not be verified
  • Placeholder URLs are now excluded via .lychee.toml instead of being modified

Checklist

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

@tannaya7
tannaya7 requested review from a team as code owners April 12, 2026 21:15
@codacy-production

codacy-production Bot commented Apr 12, 2026 •
edited
Loading

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@coderabbitai

coderabbitai Bot commented Apr 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

This pull request corrects a malformed heading in documentation and configures Lychee for link checking. The documentation fix addresses an incorrectly nested heading marker, while the new Lychee configuration defines URL exclusion patterns and request parameters to reduce false positives from known broken links.

Changes

Cohort / File(s) Summary
Documentation Heading Fix
docs/sdk_developers/training/network_and_client.md		 Corrected malformed nested heading marker in "Example: Complete Setup" section by replacing ## -### Example: Complete Setup with proper ### Example: Complete Setup formatting.
Lychee Link Checker Configuration
pyproject.toml		 Added [tool.lychee] configuration block defining URL exclusions (GitHub patterns, Hedera testnet, localhost, assets) and request/retry parameters (timeout=20s, retry_wait=2s, max_retries=3).

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 clearly summarizes the main changes: fixing broken markdown links and adding lychee configuration for link checking.
Description check ✅ Passed The description is directly related to the changeset, detailing specific fixes for broken links and the addition of lychee configuration.
Linked Issues check ✅ Passed The PR addresses issue #2050 by fixing broken markdown links and adding lychee configuration to exclude intentional placeholders from checks.
Out of Scope Changes check ✅ Passed Changes are limited to documentation fixes and link-checker configuration as specified in issue #2050; no unrelated 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.

📋 Issue Planner

Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).

View plan for ticket: #2050

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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[bot]
coderabbitai Bot reviewed Apr 12, 2026
View reviewed changes

@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: 2

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 32f11e8c-1756-4847-b983-52c841b39f44

📥 Commits

Reviewing files that changed from the base of the PR and between 817986c and 80b55a9.

📒 Files selected for processing (4)
  • .github/workflows/cron-check-broken-links.yml
  • .lychee.toml
  • docs/discord.md
  • docs/sdk_developers/training/network_and_client.md

Comment thread .github/workflows/cron-check-broken-links.yml Outdated
Comment thread docs/discord.md Outdated
@exploreriii exploreriii added status: needs committer review step: 1st 1st stage of the review approval process labels Apr 13, 2026
manishdait
manishdait reviewed Apr 14, 2026
View reviewed changes
Comment thread .lychee.toml Outdated
@exploreriii
exploreriii marked this pull request as draft April 14, 2026 17:49
@exploreriii exploreriii added dev: in progress and removed reviewer: committer step: 1st 1st stage of the review approval process labels Apr 14, 2026
@tannaya7
tannaya7 marked this pull request as ready for review April 14, 2026 18:52
@tannaya7
tannaya7 requested a review from a team as a code owner April 14, 2026 18:52
@tannaya7
tannaya7 requested a review from stoqnkpL April 14, 2026 18:52
coderabbitai[bot]
coderabbitai Bot reviewed Apr 14, 2026
View reviewed changes

@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
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3fbfd3c4-418f-433d-9631-e3518a19b2a2

📥 Commits

Reviewing files that changed from the base of the PR and between 1ab77d6 and 602bd88.

📒 Files selected for processing (1)
  • pyproject.toml

Comment thread pyproject.toml Outdated
manishdait
manishdait reviewed Apr 14, 2026
View reviewed changes
Comment thread pyproject.toml Outdated
@exploreriii exploreriii added the step: 1st 1st stage of the review approval process label Apr 14, 2026
@github-actions github-actions Bot added automated Created automatically by a workflow skill: beginner Achievable by a fairly new comer that has already completed a couple of good first issues broken-markdown-links this label reports some URLs are not found labels Apr 14, 2026
@manishdait

manishdait commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

@tannaya7, the pre-commit checks are failing you can add the pre-commit by following the docs below
Setup Docs

@exploreriii

exploreriii commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

@manishdait could you help to create a good first isssue to expand the set up in the templates to enable the pre commits?

@manishdait

manishdait commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

@manishdait could you help to create a good first isssue to expand the set up in the templates to enable the pre commits?

Yes

@manishdait

manishdait commented Apr 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@tannaya7, one of your commit is missing the signoff you can fix it by running

git rebase -i HEAD~2
git commit --amend --no-edit -s -S

exploreriii
exploreriii requested changes Apr 16, 2026
View reviewed changes

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

@tannaya7 this is good but cannot merge due to your signing

note one commit is not GPG key signed

you need all of them to be DCO+GPG key signed

i recommend
git reset --soft HEAD~14

recommit
git commit -S -s -m "chore: your message"

git push --force

Please follow the guide in the issue carefully.

@exploreriii
exploreriii marked this pull request as draft April 16, 2026 14:42
@tannaya7
tannaya7 force-pushed the fix/broken-markdown-links branch from 47939e5 to 1d60094 Compare April 16, 2026 14:48
@tannaya7
docs: fix broken markdown links and add lychee config
a619f7f 
Signed-off-by: tannaya7 <tannayasupriya157@gmail.com>
@tannaya7
tannaya7 force-pushed the fix/broken-markdown-links branch from 1d60094 to a619f7f Compare April 16, 2026 14:53
@tannaya7
tannaya7 marked this pull request as ready for review April 16, 2026 14:55
exploreriii
exploreriii approved these changes Apr 16, 2026
View reviewed changes

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

Thanks!

@exploreriii
exploreriii requested a review from manishdait April 16, 2026 15:07
@exploreriii exploreriii added step: 2nd second stage of the review approval process reviewer: write requires a review with write permissions and removed step: 1st 1st stage of the review approval process labels Apr 16, 2026
manishdait
manishdait approved these changes Apr 16, 2026
View reviewed changes

@manishdait manishdait 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.

seems good to me

@exploreriii exploreriii added step: merge ready PR is ready and waiting to merge and removed step: 2nd second stage of the review approval process reviewer: write requires a review with write permissions labels Apr 16, 2026
@exploreriii
exploreriii merged commit e9b57e5 into hiero-ledger:main Apr 16, 2026
25 checks passed
@exploreriii exploreriii added this to the v0.2.5 milestone Apr 16, 2026
Abhijeet2409 pushed a commit to Abhijeet2409/hiero-sdk-python that referenced this pull request Apr 22, 2026
@tannaya7 @Abhijeet2409
docs: fix broken markdown links and add lychee config (hiero-ledger#2114
d64aa07 
)

Signed-off-by: tannaya7 <tannayasupriya157@gmail.com>
AntonioCeppellini pushed a commit to AntonioCeppellini/hiero-sdk-python that referenced this pull request Apr 22, 2026
@tannaya7 @AntonioCeppellini
docs: fix broken markdown links and add lychee config (hiero-ledger#2114
9ef530c 
)

Signed-off-by: tannaya7 <tannayasupriya157@gmail.com>
parvninama pushed a commit to parvninama/hiero-sdk-python that referenced this pull request Apr 25, 2026
@tannaya7 @parvninama
docs: fix broken markdown links and add lychee config (hiero-ledger#2114
9c1759c 
)

Signed-off-by: tannaya7 <tannayasupriya157@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@manishdait manishdait manishdait approved these changes
@exploreriii exploreriii exploreriii approved these changes
@PavelSBorisov PavelSBorisov Awaiting requested review from PavelSBorisov PavelSBorisov is a code owner automatically assigned from hiero-ledger/github-maintainers
@AntonioCeppellini AntonioCeppellini Awaiting requested review from AntonioCeppellini AntonioCeppellini is a code owner automatically assigned from hiero-ledger/hiero-sdk-python-committers
@stoqnkpL stoqnkpL Awaiting requested review from stoqnkpL stoqnkpL is a code owner automatically assigned from hiero-ledger/tsc

Assignees

No one assigned

Labels

automated Created automatically by a workflow broken-markdown-links this label reports some URLs are not found skill: beginner Achievable by a fairly new comer that has already completed a couple of good first issues step: merge ready PR is ready and waiting to merge

Projects

None yet

Milestone

v0.2.5

Development

Successfully merging this pull request may close these issues.

Scheduled Markdown Link Check Found Broken Links

3 participants

@tannaya7 @manishdait @exploreriii