Skip to content

docs(l2): fix broken Taiko links in based rollup references#6525

Merged
ilitteri merged 1 commit into
mainfrom
docs/fix-broken-taiko-links
Apr 27, 2026
Merged

docs(l2): fix broken Taiko links in based rollup references#6525
ilitteri merged 1 commit into
mainfrom
docs/fix-broken-taiko-links

Conversation

@avilagaston9

Copy link
Copy Markdown
Contributor

Motivation

The Link Check job fails on any PR touching docs/** because three Taiko links in docs/l2/fundamentals/based.md trip lychee: two docs.taiko.xyz URLs return 404, and one taiko.mirror.xyz URL is blocked by anti-bot protection (same behavior as medium.com, which is already excluded).

Description

  • Update the "Based Rollups by Taiko" link to https://docs.taiko.xyz/protocol/based-rollups (current page on the Taiko docs site).
  • Remove the "Taiko Gwyneth" entry — returns 404, no successor found in the new docs.
  • Keep the taiko.mirror.xyz link (content is live, just bot-blocked) and exclude mirror.xyz from lychee, same treatment as the existing medium.com exclusion.

The Link Check job fails on any PR touching docs/** because three Taiko
links in docs/l2/fundamentals/based.md trip lychee: two docs.taiko.xyz
URLs return 404, and one taiko.mirror.xyz URL is blocked by anti-bot
protection (same behavior as medium.com, which is already excluded).

- Update the "Based Rollups by Taiko" link to
  docs.taiko.xyz/protocol/based-rollups (current page on the Taiko docs
  site).
- Remove the "Taiko Gwyneth" entry: returns 404, no successor found in
  the new docs.
- Keep the taiko.mirror.xyz link (content is live, just bot-blocked) and
  exclude mirror.xyz from lychee, same treatment as the existing
  medium.com exclusion.
@github-actions github-actions Bot added the L2 Rollup client label Apr 24, 2026
@avilagaston9 avilagaston9 marked this pull request as ready for review April 24, 2026 18:48
@avilagaston9 avilagaston9 requested a review from a team as a code owner April 24, 2026 18:48
Copilot AI review requested due to automatic review settings April 24, 2026 18:48
@github-actions

Copy link
Copy Markdown

🤖 Claude Code Review


PR #6525 Review: docs(l2): fix broken Taiko links in based rollup references

Overview

A narrow, documentation-only PR. Three link-check failures in CI are addressed:

  • One dead URL updated to the current Taiko docs page.
  • One 404-with-no-successor removed entirely.
  • One mirror.xyz URL excluded from lychee (bot-blocked, like the existing medium.com exclusion).

Analysis

.github/workflows/pr-main_mdbook.yml

Adding --exclude 'mirror.xyz' mirrors the existing treatment of medium.com. This is reasonable: the content is live, the failure is an anti-bot false positive, and the pattern is consistent with the established approach. No concerns.

docs/l2/fundamentals/based.md — link update

https://docs.taiko.xyz/taiko-alethia-protocol/protocol-design/based-rollups/https://docs.taiko.xyz/protocol/based-rollups

The motivation is clear and the replacement URL is the correct current location on the Taiko docs site. Good.

docs/l2/fundamentals/based.md — Taiko Gwyneth removal

Removing a dead link with no successor is the right call. The PR description confirms due diligence was done to look for a replacement.

One minor nit: the removal leaves a trailing blank line between the Taiko Alethia entry and ### Misc. This is cosmetic and won't affect rendered output, but could be cleaned up.


Summary

The changes are correct, well-motivated, and consistent with project conventions. The CI fix is sound. No correctness, security, or Ethereum-specific concerns apply — this is purely documentation and workflow maintenance.

Verdict: Approve. Optionally clean up the extra blank line left after the removed entry (line ~430 in based.md), but this is not blocking.


Automated review by Claude (Anthropic) · sonnet · custom prompt

@github-actions

Copy link
Copy Markdown

🤖 Kimi Code Review

Review for PR #6525 (Documentation link maintenance)

Overall Assessment: Straightforward documentation maintenance PR. No code changes, only link updates and CI configuration.

Specific Feedback:

.github/workflows/pr-main_mdbook.yml (Line 56)
Adding --exclude 'mirror.xyz' to lychee is pragmatic if the site blocks automated requests/returns 403s in CI, but note that this reduces link checking coverage for a legitimate crypto publishing platform. Consider adding a comment explaining why it's excluded (e.g., # mirror.xyz blocks GitHub Actions IPs).

docs/l2/fundamentals/based.md

  • Line 420 (Taiko Alethia link update): The URL change from /taiko-alethia-protocol/protocol-design/based-rollups/ to /protocol/based-rollups appears to reflect Taiko's documentation restructuring. Verify the new URL returns 200 (assumed correct).

  • Line 432 (Taiko Gwyneth removal): The removal of the Gwyneth protocol link suggests this project may have been deprecated or consolidated. If Taiko Gwyneth content still exists at a new location (e.g., under /protocol/ or archived), consider updating rather than removing. If deliberately removed due to project sunset, this is fine.

Suggestion: If the Gwyneth content is truly gone, consider adding a note that Taiko Gwyneth was previously documented here but has been sunset/merged, rather than silent deletion, for historical context.

No security or consensus issues - documentation only.


Automated review by Kimi (Moonshot AI) · kimi-k2.5 · custom prompt

@greptile-apps

greptile-apps Bot commented Apr 24, 2026

Copy link
Copy Markdown

Greptile Summary

This PR fixes three broken Taiko links in docs/l2/fundamentals/based.md that were causing the Link Check CI job to fail. The "Based Rollups by Taiko" URL is updated to its current location, the dead "Taiko Gwyneth" entry is removed, and mirror.xyz is added to the lychee exclusion list (same treatment as the existing medium.com exclusion) so the live-but-bot-blocked taiko.mirror.xyz link no longer trips the checker.

Confidence Score: 5/5

Safe to merge — targeted documentation and CI-config fix with no logic changes.

All changes are purely documentation link updates and a lychee exclusion addition. No logic, security, or correctness concerns. All findings are P2 or lower.

No files require special attention.

Important Files Changed

Filename Overview
.github/workflows/pr-main_mdbook.yml Adds --exclude 'mirror.xyz' to the lychee link-checker arguments, mirroring the existing medium.com exclusion for bot-blocked sites.
docs/l2/fundamentals/based.md Updates the "Based Rollups by Taiko" link to the current docs URL and removes the dead "Taiko Gwyneth" link.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR touches docs/**] --> B[Lint job - mdBook build]
    B --> C[Link Check job - lychee]
    C --> D{Link valid?}
    D -->|excluded: localhost\nmedium.com\nmirror.xyz| E[Pass ✅]
    D -->|404 / error| F[Fail ❌]
    D -->|200 OK| E
Loading

Reviews (1): Last reviewed commit: "docs(l2): fix broken Taiko links in base..." | Re-trigger Greptile

Copilot AI 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.

Pull request overview

Fixes broken/excluded external links in L2 “based rollup” documentation to keep the Link Check job passing while preserving relevant references.

Changes:

  • Update the Taiko “Based Rollups” reference to the current Taiko docs URL.
  • Remove the 404’ing “Taiko Gwyneth” reference.
  • Exclude mirror.xyz from lychee checks to avoid anti-bot failures on taiko.mirror.xyz.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/l2/fundamentals/based.md Updates/removes Taiko references to eliminate 404 links in the docs.
.github/workflows/pr-main_mdbook.yml Adjusts lychee link-check arguments to exclude mirror.xyz (bot-blocked).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

uses: lycheeverse/lychee-action@v2
with:
args: --no-progress --exclude 'localhost' --exclude 'medium.com' docs/
args: --no-progress --exclude 'localhost' --exclude 'medium.com' --exclude 'mirror.xyz' docs/

Copilot AI Apr 24, 2026

Copy link

Choose a reason for hiding this comment

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

lychee --exclude values are regular expressions; unescaped dots match any character. Since this line is being updated, consider escaping the dots so you exclude only the intended domains (e.g., medium\.com and mirror\.xyz, or even taiko\.mirror\.xyz for tighter scoping) rather than accidentally skipping URLs that just happen to match the regex.

Suggested change
args: --no-progress --exclude 'localhost' --exclude 'medium.com' --exclude 'mirror.xyz' docs/
args: --no-progress --exclude 'localhost' --exclude 'medium\.com' --exclude 'mirror\.xyz' docs/

Copilot uses AI. Check for mistakes.
@github-actions

Copy link
Copy Markdown

🤖 Codex Code Review

  1. Low: pr-main_mdbook.yml excludes mirror.xyz at the host level. The only current Mirror link I found is based.md, so this weakens CI more than necessary and will let any future broken or mistyped mirror.xyz links pass silently. Prefer excluding that exact URL, or replacing the single Mirror article with a canonical non-Mirror source.

No other findings. This PR is docs/CI-only, and I don’t see any impact on execution correctness, gas accounting, consensus behavior, or Rust safety. I couldn’t verify the external URLs themselves locally because network access is restricted.


Automated review by OpenAI Codex · gpt-5.4 · custom prompt

@ilitteri ilitteri added this pull request to the merge queue Apr 27, 2026
Merged via the queue into main with commit 10cf62d Apr 27, 2026
75 checks passed
@ilitteri ilitteri deleted the docs/fix-broken-taiko-links branch April 27, 2026 14:50
avilagaston9 pushed a commit that referenced this pull request Apr 27, 2026
…the Taiko-links docs fix from #6525. Conflict in .github/workflows/pr-main_mdbook.yml on the lychee exclude list resolved by unioning both sides: keep `--exclude 'stateless-validation.l2beat.com'` (added on this branch for the native rollup docs that link to the L2Beat native rollups page) and `--exclude 'mirror.xyz'` (added on main for taiko.mirror.xyz now linked from docs/l2/fundamentals/based.md). docs/l2/fundamentals/based.md auto-merged cleanly with main's link updates.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

L2 Rollup client

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants