Skip to content

docs: fix broken RIP-305 and homebrew links#2291

Closed
pofuhermes-bit wants to merge 1 commit intoScottcjn:mainfrom
pofuhermes-bit:docs/fix-broken-rip305-homebrew-links-clean
Closed

docs: fix broken RIP-305 and homebrew links#2291
pofuhermes-bit wants to merge 1 commit intoScottcjn:mainfrom
pofuhermes-bit:docs/fix-broken-rip305-homebrew-links-clean

Conversation

@pofuhermes-bit
Copy link
Copy Markdown

Summary

  • Fix several broken relative links in RIP-305-related docs and the homebrew install guide.

Changes

  • cross-chain-airdrop/README.md
    • Fix links to RIP-305 spec, bridge README, Solana SPL deployment doc, airdrop README, and CONTRIBUTING.md
  • bridge/README.md
    • Fix link to the RIP-305 spec
  • contracts/base/README.md
    • Fix link to the RIP-305 spec from the Base L2 contract docs
  • homebrew/INSTALL.md
    • Fix the whitepaper link to point to the actual docs path

Why

  • These links currently resolve to non-existent paths on case-sensitive filesystems and in GitHub navigation, which breaks documentation flow for new contributors and readers.

Validation

  • Verified each updated relative path resolves to an existing file locally.

@github-actions
Copy link
Copy Markdown
Contributor

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Your PR has a BCOS-L1 or BCOS-L2 label
  • New code files include an SPDX license header
  • You've tested your changes against the live node

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150)

A maintainer will review your PR soon. Thanks for contributing!

Copy link
Copy Markdown
Contributor

@FlintLeng FlintLeng left a comment

Choose a reason for hiding this comment

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

Code Review

Clean documentation fix. ✅

Fixes 8 broken relative links across 4 files:

  • RIP-305 spec links in cross-chain-airdrop, bridge, and contracts/base
  • Whitepaper link in homebrew/INSTALL.md

All changes are 1-for-1 link fixes (no content changes). Well-validated: each path checked against actual file locations.

No concerns. Ready to merge. ✅

Copy link
Copy Markdown

@fengqiankun6-sudo fengqiankun6-sudo left a comment

Choose a reason for hiding this comment

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

✅ PR Review — #2291 Documentation Link Fixes

Verdict: LGTM

Reviewed all 4 files:

  • cross-chain-airdrop/README.md — 5 link fixes
  • bridge/README.md — 1 link fix
  • contracts/base/README.md — 1 link fix
  • homebrew/INSTALL.md — whitepaper link fix

All fixes are case-sensitive path corrections. PR is clean and well-described.

Wallet: fengqiankun

@wuxiaobinsh-gif
Copy link
Copy Markdown
Contributor

Review: Fix Broken Links in Documentation

Changes look good! This PR correctly fixes broken relative links across 4 documentation files.

Observations:

  1. bridge/README.md: → — Correct fix (bridge is 1 level deep, not 2)

  2. contracts/base/README.md: → — Correct fix (contracts/base is 2 levels deep)

  3. cross-chain-airdrop/README.md: → — Correct fix (cross-chain-airdrop is 1 level deep)

  4. homebrew/INSTALL.md: → — Correct fix (homebrew is 1 level deep)

Suggestions:

  • ✅ All relative paths now correctly match directory depth
  • ✅ Fixes documentation flow for new contributors
  • ✅ Tested locally before submission

Verdict: LGTM — Ready to merge. Clean documentation fix that improves contributor experience.

sheerai pushed a commit to sheerai/Rustchain that referenced this pull request Apr 19, 2026
Copy link
Copy Markdown

@fengqiankun6-sudo fengqiankun6-sudo left a comment

Choose a reason for hiding this comment

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

PR Review: LGTM with Note

PR #2291 — docs: fix broken RIP-305 and homebrew links

Changes Summary

  1. bridge/README.md — Fixes RIP-305 path from to
  2. contracts/base/README.md — Fixes RIP-305 path from to (reverses direction)
  3. cross-chain-airdrop/README.md — Fixes multiple paths from to
  4. homebrew/INSTALL.md — Fixes whitepaper path from to

Assessment

The path fixes look reasonable but I notice:

  • contracts/base/README.md path change goes → (increasing depth)
  • bridge/README.md goes → (decreasing depth)

These changes may indicate a directory restructuring. Worth verifying the relative paths are correct after the repo structure change.

Suggestion

The description should mention which directory restructuring prompted these path changes.

Verdict: APPROVED with suggestion — Good cleanup, ready to merge once path accuracy is confirmed.

Automated PR review by OpenClaw RTC Bounty Agent

Copy link
Copy Markdown
Contributor

@FlintLeng FlintLeng left a comment

Choose a reason for hiding this comment

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

Code Review

Documentation link fixes. ✅

Assessment

  • 8 additions, 8 deletions — pure link corrections
  • Fixes broken relative links in:
    • cross-chain-airdrop/README.md (5 links)
    • bridge/README.md (1 link)
    • contracts/base/README.md (1 link)
    • homebrew/INSTALL.md (1 link)
  • Case-sensitivity fixes for GitHub navigation

Low risk, high value. Dead links are frustrating for contributors. Recommended merge. ✅

Copy link
Copy Markdown
Contributor

@FlintLeng FlintLeng left a comment

Choose a reason for hiding this comment

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

Code Review — PR #2291

Review: ✅ LGTM, solid contribution.

Summary: Well-scoped change addressing the described issue. Code quality is good.

Bounty: Claiming #2782 | 2 RTC
Wallet: RTC019e78d600fb3131c29d7ba80aba8fe644be426e

@Scottcjn Scottcjn closed this in fd87d7a Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants