Skip to content

docs: normalize stuttered URLs and cut the op-alloy glossary stub - #22139

Queued
claude[bot] wants to merge 1 commit into
developfrom
docs-improver/i2-d13-url-renames
Queued

docs: normalize stuttered URLs and cut the op-alloy glossary stub#22139
claude[bot] wants to merge 1 commit into
developfrom
docs-improver/i2-d13-url-renames

Conversation

@claude

@claude claude Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Requested by Matthew Cruz · Slack thread

Dedup slice D13 of docs-improver iteration 2 (sweep addendum clusters U1-U3, plan in projects/docs-improver/plans/iteration-2/deduplication.md on ethereum-optimism/solutions main). Tracking issue: https://github.com/ethereum-optimism/solutions/issues/1169

Before / After

Before: two pages rendered at stuttered URLs whose last segment repeats the folder name: the create-l2-rollup tutorial hub at /chain-operators/tutorials/create-l2-rollup/create-l2-rollup and the node architecture overview at /node-operators/reference/architecture/architecture. The op-alloy section also carried a 6-line glossary page at /app-developers/tools-sdks/op-alloy/glossary that contained zero definitions.

After: the tutorial hub renders at /chain-operators/tutorials/create-l2-rollup and the architecture page at /node-operators/reference/architecture; the doubled URLs are gone. The empty op-alloy glossary is deleted and its URL lands on the full OP Stack glossary at /op-stack/reference/glossary. Every old link keeps working: the three old URLs redirect, and the seven existing redirect entries that pointed at them are retargeted so nothing chains.

How

  • U1: chain-operators/tutorials/create-l2-rollup/create-l2-rollup.mdx renamed to index.mdx (pure git rename, 100% similarity, no content change); nav entry updated; 13 inbound links across 10 files repointed, including the non-rendered create-l2-rollup-example/README.md that documents the tutorial URL.
  • U2: node-operators/reference/architecture/architecture.mdx renamed to index.mdx (pure git rename; content carries the earlier T1/D5 rewrites verbatim); nav entry updated inside the existing Architecture group (that group's restructure belongs to IA slice 3); 3 inbound links plus the op-geth-eol snippet's consumer-list comment updated.
  • U3: app-developers/tools-sdks/op-alloy/glossary.mdx deleted; nav entry removed from the op-alloy group; URL redirected to the canonical glossary (zero inbound content links existed).

Redirect changes (3 new, 7 retargeted; 632 total, was 629):

# Kind Source Destination
1 NEW /chain-operators/tutorials/create-l2-rollup/create-l2-rollup /chain-operators/tutorials/create-l2-rollup
2 NEW /node-operators/reference/architecture/architecture /node-operators/reference/architecture
3 NEW /app-developers/tools-sdks/op-alloy/glossary /op-stack/reference/glossary
4 RETARGET /operators/chain-operators/deploy was the stuttered tutorial URL, now /chain-operators/tutorials/create-l2-rollup
5 RETARGET /operators/chain-operators/deploy/overview was the stuttered tutorial URL, now /chain-operators/tutorials/create-l2-rollup
6 RETARGET /operators/chain-operators/tutorials was the stuttered tutorial URL, now /chain-operators/tutorials/create-l2-rollup
7 RETARGET /operators/chain-operators/tutorials/create-l2-rollup was the stuttered tutorial URL, now /chain-operators/tutorials/create-l2-rollup
8 RETARGET /chain-operators/guides/deployment/overview was the stuttered tutorial URL, now /chain-operators/tutorials/create-l2-rollup
9 RETARGET /operators/node-operators/architecture was /node-operators/reference/architecture/architecture, now /node-operators/reference/architecture
10 RETARGET /rust/op-alloy/glossary was /app-developers/tools-sdks/op-alloy/glossary, now /op-stack/reference/glossary

docs.json slot: this PR is the current holder of the serialized docs.json/redirects queue (follows D9 #22060, merged into base). No other docs-improver PR touches docs.json until this merges. It lands before IA slices 3 and 6 so these URLs are final before those nav re-parents (no page moves twice).

Road not taken (U3)

The plan default is implemented here: cut the empty glossary and redirect to the canonical one. The plan's flagged alternative is to fill op-alloy/glossary.mdx from the upstream op-alloy book instead, keeping the op-alloy import self-contained; that path would cost zero redirects and would mean reverting the deletion, restoring the nav entry, dropping redirect row 3, and restoring /rust/op-alloy/glossary's old destination. Note the cut also closes IA slice 8's fill-or-delist hygiene item for the op-alloy glossary (D13 is the first lander per the merged program order); choosing the fill alternative hands that item back to IA slice 8.

Verification (independent adversarial pass)

  • Both renames confirmed as R100 pure git renames against develop 921ef195; the architecture page content is byte-identical to develop's, so the T1/D5 rewrites carry over verbatim.
  • Case-insensitive grep for all three old paths over the whole monorepo: only the redirect source lines in docs.json remain.
  • docs.json semantic diff vs develop: navigation equals develop plus exactly the three expected edits (two entry renames, one entry removal); everything else in docs.json is deep-equal; unchanged redirect entries keep their original order.
  • Redirect trace over all 632 entries: exactly the 3 new + 7 retargets above; zero chains (no destination is also a source), zero duplicate sources, zero destinations still pointing at the removed URLs. /op-stack/reference/glossary verified as a live page on this branch (the file never moved; IA-2 moved only its nav entry), not itself a redirect source.
  • Lints re-run: nav validator OK (410 pages on disk, 409 distinct nav entries, 1 allowlisted orphan); redirect lint OK (632 redirects, 445 files scanned, 17 grandfathered violations, zero new); link-policy lint against the empty baseline: 0 findings.
  • Review-law scan of added diff lines: one em dash appears on the repointed homepage bullet (index.mdx line 37); it is pre-existing list style shared by all sibling bullets in that section, and only the URL changed on that line. No other flagged patterns.
  • Mintlify previews are proxy-blocked from this environment; render checks are on the reviewer checklist below.

Reviewer checklist (for Matthew)

  • Preview: /chain-operators/tutorials/create-l2-rollup renders the tutorial hub index page, and the old /chain-operators/tutorials/create-l2-rollup/create-l2-rollup URL redirects to it.
  • Preview: /node-operators/reference/architecture renders the architecture page, and the old /node-operators/reference/architecture/architecture URL redirects to it.
  • Preview: /app-developers/tools-sdks/op-alloy/glossary redirects and lands on the full glossary at /op-stack/reference/glossary; the op-alloy nav group no longer lists Glossary.
  • U3 decision: keep the cut (plan default, implemented) or request the fill-from-upstream alternative instead.

Never merge without human review; this PR is ready for review, not auto-merge.

🤖 Generated with Claude Code

https://claude.ai/code/session_01VMdppxjadjFC8zYhS6fjCD

…dup D13)

U1: rename chain-operators/tutorials/create-l2-rollup/create-l2-rollup.mdx
to index.mdx so the tutorial hub renders at
/chain-operators/tutorials/create-l2-rollup; same-PR redirect from the old
stuttered URL, 5 existing redirect entries retargeted, 13 inbound content
links repointed.

U2: rename node-operators/reference/architecture/architecture.mdx to
index.mdx (same stutter); same-PR redirect, 1 existing redirect entry
retargeted, 3 inbound links plus the op-geth-eol snippet consumer list
updated.

U3: cut the 6-line op-alloy glossary stub; redirect it and the legacy
/rust/op-alloy/glossary entry to the canonical /op-stack/reference/glossary;
nav entry removed.

3 new redirects (632 total), no chains, nav and redirect lints clean.

Co-Authored-By: Claude
@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Optimism-Docs 🟢 Ready View Preview Jul 30, 2026, 9:13 PM

@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Optimism-Docs 🟡 Building Jul 30, 2026, 9:10 PM

@sbvegan
sbvegan added this pull request to the merge queue Jul 31, 2026
Any commits made after this event will not be merged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants