Skip to content

chore(rust): unify rust docs and update repo links#19101

Merged
sebastianst merged 2 commits intodevelopfrom
theo/unify-rust-docs
Feb 13, 2026
Merged

chore(rust): unify rust docs and update repo links#19101
sebastianst merged 2 commits intodevelopfrom
theo/unify-rust-docs

Conversation

@theochap
Copy link
Member

@theochap theochap commented Feb 5, 2026

Note

Stacked on top of #18968 and #19034

Summary

Unifies the three separate documentation sites for kona, op-reth, and op-alloy into a single Vocs-powered docs site at rust/docs/, and updates all repository links that pointed to the old standalone repos (alloy-rs/op-alloy, paradigmxyz/op-reth) to point to ethereum-optimism/optimism.

Documentation unification

Previously, each Rust subproject maintained its own independent documentation site:

  • kona had a Vocs site at rust/kona/docs/ with its own vocs.config.ts, sidebar, and package.json
  • op-reth had a Vocs site at rust/op-reth/docs/vocs/ with its own config and sidebar
  • op-alloy had an mdBook site at rust/op-alloy/book/ using book.toml

This PR consolidates all three into a single unified Vocs site at rust/docs/:

  • Pages are organized under docs/pages/kona/, docs/pages/op-reth/, and docs/pages/op-alloy/
  • A single vocs.config.ts provides a unified top navigation bar with sections for each project
  • Each project retains its own sidebar definition (sidebar-kona.ts, sidebar-op-reth.ts, sidebar-op-alloy.ts) composed into a single sidebar.ts
  • Shared assets (logo, favicon, styles) are consolidated in docs/public/ and docs/styles.css
  • The old standalone doc directories (kona/docs/, op-reth/docs/vocs/, op-alloy/book/) are removed

Link updates

Updated links across multiple files pointing from old repos to ethereum-optimism/optimism:

Cargo.toml (7 crates) — homepage and repository fields:

  • op-alloy/crates/{consensus,op-alloy,rpc-types,rpc-types-engine,provider,rpc-jsonrpsee,network}/Cargo.toml

README.md (8 files) — removed CI badges, license badges:

Doc pages (4 .mdx files):

  • docs/docs/pages/op-alloy/starting.mdx — repo link + script link
  • docs/docs/pages/kona/sdk/protocol/{intro,registry}.mdx — reference links
  • docs/docs/pages/kona/node/run/docker.mdx — docker image reference

Other:

  • op-alloy/cliff.toml — release and issue link templates
  • kona/docker/recipes/kona-node{,-dev}/grafana/dashboards/overview.json — dashboard links

Not updated (intentionally)

  • CHANGELOG.md files — historical references to PRs/issues that still live on the old repos
  • Source code issue/PR/commit links — e.g. alloy-rs/op-alloy/issues/18, alloy-rs/op-alloy/pull/130 — these reference specific artifacts on the original repos that won't exist on the monorepo

Test plan

  • Verify links resolve correctly on GitHub
  • Verify docs site builds with just docs-serve from rust/docs/
  • Spot-check kona, op-reth, and op-alloy doc pages render correctly in the unified site

🤖 Generated with Claude Code

@theochap theochap requested review from a team as code owners February 5, 2026 20:19
@theochap theochap requested a review from scharissis February 5, 2026 20:19
@wiz-inc-a178a98b5d
Copy link

wiz-inc-a178a98b5d bot commented Feb 5, 2026

Wiz Scan Summary

Scanner Findings
Vulnerability Finding Vulnerabilities -
Data Finding Sensitive Data -
Secret Finding Secrets -
IaC Misconfiguration IaC Misconfigurations -
SAST Finding SAST Findings -
Software Management Finding Software Management Findings -
Total -

View scan details in Wiz

To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension.

@codecov
Copy link

codecov bot commented Feb 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.7%. Comparing base (3235773) to head (ae05978).
⚠️ Report is 3 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #19101      +/-   ##
===========================================
- Coverage     76.3%    75.7%    -0.7%     
===========================================
  Files          188      692     +504     
  Lines        10946    71528   +60582     
===========================================
+ Hits          8360    54159   +45799     
- Misses        2440    17225   +14785     
+ Partials       146      144       -2     
Flag Coverage Δ
cannon-go-tests-64 66.4% <ø> (-0.9%) ⬇️
contracts-bedrock-tests 81.6% <ø> (ø)
unit 75.6% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
rust/kona/bin/supervisor/src/main.rs 0.0% <ø> (ø)
rust/kona/crates/node/engine/src/client.rs 0.0% <ø> (ø)
rust/kona/crates/node/gossip/src/driver.rs 65.3% <ø> (ø)
rust/kona/crates/protocol/registry/src/lib.rs 93.0% <ø> (ø)
...p-reth/crates/txpool/src/supervisor/access_list.rs 45.4% <ø> (ø)
...st/op-reth/crates/txpool/src/supervisor/message.rs 0.0% <ø> (ø)

... and 503 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@theochap theochap changed the base branch from develop to push-xlmsvlxyospu February 5, 2026 20:20
@theochap theochap force-pushed the theo/unify-rust-docs branch from d298f8b to 5ee0017 Compare February 5, 2026 20:47
@theochap theochap force-pushed the theo/unify-rust-docs branch 3 times, most recently from 89f57ca to 2ece9a8 Compare February 10, 2026 19:00
@almanax-ai
Copy link
Contributor

almanax-ai bot commented Feb 10, 2026

Plan expired

Your subscription has expired. Please renew your subscription to continue using CI/CD integration and other features.

Base automatically changed from push-xlmsvlxyospu to develop February 11, 2026 15:23
@theochap theochap force-pushed the theo/unify-rust-docs branch from 2ece9a8 to 4bacba8 Compare February 11, 2026 16:17
@theochap theochap force-pushed the theo/unify-rust-docs branch from 4bacba8 to 8759a53 Compare February 11, 2026 17:52
@theochap theochap force-pushed the theo/unify-rust-docs branch from 8759a53 to 56c0473 Compare February 12, 2026 17:38
@theochap theochap requested a review from a team as a code owner February 12, 2026 17:38
@theochap theochap requested a review from teddyknox February 12, 2026 17:38
@theochap theochap force-pushed the theo/unify-rust-docs branch from 56c0473 to 7d7d3af Compare February 12, 2026 17:42
@theochap theochap force-pushed the theo/unify-rust-docs branch 8 times, most recently from c1cfe0f to 4128856 Compare February 12, 2026 18:20
@theochap theochap force-pushed the theo/unify-rust-docs branch from 4128856 to ae05978 Compare February 12, 2026 18:32
@sebastianst sebastianst added this pull request to the merge queue Feb 13, 2026
Merged via the queue into develop with commit e82fb7b Feb 13, 2026
119 checks passed
@sebastianst sebastianst deleted the theo/unify-rust-docs branch February 13, 2026 10:45
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