Scheduled Markdown Link Check Found Broken Links

[github-actions]

🔗 Broken Links Detected

The scheduled markdown link check workflow has detected broken links.

Run Details:

• Timestamp: 2026-04-01T00:29:50.624Z
• Workflow Run: View Logs

Note: We use Lychee for link checking. Please check the "Check Markdown links" step in the logs to see the specific URLs that failed.

[github-actions]

Hello, this is CommunityCallBot.

This is a reminder that the Hiero Python SDK Community Call will begin in approximately 4 hours (14:00 UTC).

The call is an open forum where contributors and users can discuss topics, raise issues, and influence the direction of the Python SDK.

Details:

• Time: 14:00 UTC
• Join Link: Zoom Meeting

Disclaimer: This is an automated reminder. Please verify the schedule here for any changes.

[github-actions]

@coderabbitai plan

[coderabbitai]

Coding Plan

Summary

• Fix three genuine documentation errors: an incorrect repository name, a truncated Discord channel ID, and leaked diff markers
• Create a .lychee.toml configuration file to exclude intentional placeholder URLs from link checking rather than modifying educational examples
• This approach maintains the illustrative value of example URLs while preventing false-positive failures in the link-checking workflow

Design Choices

Design Choice 1: How should placeholder URLs in example code blocks be handled?

Options Considered:

1. Replace placeholder URLs with real repository URLs
2. Exclude placeholder URL patterns in Lychee configuration

Chosen Option: 2

Rationale: Exclude via configuration—these are illustrative examples meant to show format, not actual links users should visit.

Design Choice 2: How should the example transaction ID URL be handled?

Options Considered:

1. Remove the example URL entirely
2. Replace with a known-good historical transaction
3. Exclude the example pattern in Lychee configuration

Chosen Option: 3

Rationale: Exclude via configuration—the fake transaction ID serves an educational purpose showing URL structure without requiring maintenance of a real transaction reference.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Fix Actual Documentation Errors

This phase addresses genuine errors in documentation files where links are malformed, incorrect, or corrupted by merge artifacts.

Task 1: Fix Incorrect Repository Name in Rebasing Guide

The rebasing documentation contains a placeholder URL pointing to the wrong repository.

• Update docs/sdk_developers/rebasing.md line 29 to change hiero-website to hiero-sdk-python in the placeholder URL
• The URL pattern YOUR_GITHUB_NAME/hiero-website should become YOUR_GITHUB_NAME/hiero-sdk-python to match the repository this documentation belongs to

Task 2: Fix Truncated Discord Channel ID

One Discord channel deep link has an incorrect channel ID that is too short to be valid.

• Update docs/discord.md line 33 where the #hiero-announcements channel link uses ID 128348704648423427 (15 digits)
• Valid Discord snowflake IDs are 18-19 digits; this ID appears truncated
• Either obtain the correct channel ID or remove this specific deep link and use the general Discord invite link instead

Task 3: Fix Diff Markers in Network and Client Documentation

Merge conflict artifacts have leaked into the documentation prose.

• Update docs/sdk_developers/training/network_and_client.md lines 376-379 to remove the diff markers (- and + prefixes)
• Clean up the malformed heading and code block structure that resulted from these artifacts
• Ensure the "Example: Complete Setup" section renders correctly as a proper markdown heading followed by a Python code block

🤖 Prompt for AI agents

Fix three genuine documentation errors across different files in the `docs/`
directory.

**Task 1: Fix incorrect repository name in `docs/sdk_developers/rebasing.md`**
- On line 29, replace the string `hiero-website` with `hiero-sdk-python` in the
placeholder URL
- The pattern `YOUR_GITHUB_NAME/hiero-website` should become
`YOUR_GITHUB_NAME/hiero-sdk-python`

**Task 2: Fix truncated Discord channel ID in `docs/discord.md`**
- On line 33, locate the `#hiero-announcements` channel deep link using ID
`128348704648423427` (which is only 15 digits and invalid as a Discord snowflake
ID)
- Either replace it with the correct 18-19 digit channel ID, or remove this
specific deep link and substitute the general Discord invite link

**Task 3: Remove diff markers from
`docs/sdk_developers/training/network_and_client.md`**
- On lines 376-379, remove the leaked diff/merge conflict markers (`-` and `+`
prefixes)
- Clean up the malformed heading and code block structure caused by these
artifacts
- Ensure the "Example: Complete Setup" section renders as a proper markdown
heading followed by a valid Python code block

Phase 2: Add Lychee Configuration for Intentional Exclusions

This phase creates a configuration file to prevent Lychee from flagging intentional placeholder URLs and example endpoints that are not meant to resolve.

Task 1: Create Lychee Configuration File

Add a configuration file to exclude known-good placeholder patterns from link checking.

• Create .lychee.toml in the repository root
• Configure exclusions for the following URL patterns:
  • github.com/owner/repo — placeholder pattern used in bot documentation examples
  • github.com/YOUR_ — placeholder patterns for user-specific fork URLs
  • testnet.mirrornode.hedera.com/api/v1/transactions/0.0.123 — fake example transaction IDs
  • localhost — local development URLs
  • github.com/user-attachments/assets/ — GitHub CDN URLs that may be ephemeral
• Set appropriate timeout and retry settings for external URLs
• Add comments explaining why each exclusion exists

Task 2: Update Lychee Workflow to Use Configuration

Ensure the cron workflow uses the new configuration file.

• Update .github/workflows/cron-check-broken-links.yml to reference the new .lychee.toml configuration
• The Lychee action automatically detects .lychee.toml in the repository root, but explicitly referencing it ensures clarity
• Verify the args parameter doesn't override config file settings

🤖 Prompt for AI agents

Create a Lychee configuration file and update the cron workflow to use it, in
order to exclude intentional placeholder URLs from link checking.

**Task 1: Create `.lychee.toml` in the repository root**
- Add exclusion rules for the following URL patterns, with inline comments
explaining the reason for each:
- `github.com/owner/repo` — placeholder pattern used in bot documentation
examples
  - `github.com/YOUR_` — placeholder patterns for user-specific fork URLs
- `testnet.mirrornode.hedera.com/api/v1/transactions/0.0.123` — fake example
transaction IDs
  - `localhost` — local development URLs
- `github.com/user-attachments/assets/` — GitHub CDN URLs that may be ephemeral
- Set appropriate timeout and retry settings for external URLs

**Task 2: Update `.github/workflows/cron-check-broken-links.yml`**
- Reference the new `.lychee.toml` configuration file explicitly
- Verify that the `args` parameter in the workflow does not override settings
from the config file

Research

This repository uses two link-checking workflows: a monthly Lychee-based cron job that checks all markdown files, and a PR-based check using markdown-link-check for modified files only. Neither workflow has any exclusion configuration, meaning all URLs—including intentional placeholder examples—are validated against live endpoints. The documentation lives primarily in docs/ with subdirectories for maintainers, SDK developers, and training materials. No .lychee.toml or similar configuration file currently exists.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Fix three genuine documentation errors across different files in the `docs/`
directory.

**Task 1: Fix incorrect repository name in `docs/sdk_developers/rebasing.md`**
- On line 29, replace the string `hiero-website` with `hiero-sdk-python` in the
placeholder URL
- The pattern `YOUR_GITHUB_NAME/hiero-website` should become
`YOUR_GITHUB_NAME/hiero-sdk-python`

**Task 2: Fix truncated Discord channel ID in `docs/discord.md`**
- On line 33, locate the `#hiero-announcements` channel deep link using ID
`128348704648423427` (which is only 15 digits and invalid as a Discord snowflake
ID)
- Either replace it with the correct 18-19 digit channel ID, or remove this
specific deep link and substitute the general Discord invite link

**Task 3: Remove diff markers from
`docs/sdk_developers/training/network_and_client.md`**
- On lines 376-379, remove the leaked diff/merge conflict markers (`-` and `+`
prefixes)
- Clean up the malformed heading and code block structure caused by these
artifacts
- Ensure the "Example: Complete Setup" section renders as a proper markdown
heading followed by a valid Python code block
===============================================================================

Task: 2

Create a Lychee configuration file and update the cron workflow to use it, in
order to exclude intentional placeholder URLs from link checking.

**Task 1: Create `.lychee.toml` in the repository root**
- Add exclusion rules for the following URL patterns, with inline comments
explaining the reason for each:
- `github.com/owner/repo` — placeholder pattern used in bot documentation
examples
  - `github.com/YOUR_` — placeholder patterns for user-specific fork URLs
- `testnet.mirrornode.hedera.com/api/v1/transactions/0.0.123` — fake example
transaction IDs
  - `localhost` — local development URLs
- `github.com/user-attachments/assets/` — GitHub CDN URLs that may be ephemeral
- Set appropriate timeout and retry settings for external URLs

**Task 2: Update `.github/workflows/cron-check-broken-links.yml`**
- Reference the new `.lychee.toml` configuration file explicitly
- Verify that the `args` parameter in the workflow does not override settings
from the config file

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[vidhhya1]

I'd like to work on this

[github-actions]

👋 Hi @vidhhya1! Thanks for your interest in contributing 💡

Before taking on a beginner issue, we ask contributors to complete at least one Good First Issue to get familiar with the workflow.

👉 Find a Good First Issue here

Please try a GFI first, then come back — we’ll be happy to assign this! 😊