Skip to content

op-reth: port documentation from reth to op-reth#18968

Merged
theochap merged 1 commit intodevelopfrom
push-xlmsvlxyospu
Feb 11, 2026
Merged

op-reth: port documentation from reth to op-reth#18968
theochap merged 1 commit intodevelopfrom
push-xlmsvlxyospu

Conversation

@theochap
Copy link
Member

@theochap theochap commented Jan 28, 2026

Summary

  • Ports OP Stack documentation from the upstream reth repository into op-reth/docs/vocs/, including the OP Stack running guide, sync FAQ, and full CLI reference (64 pages).
  • Adds a Vocs-based documentation site with vocs.config.ts, sidebar navigation, package.json, and tsconfig.json configured for op-reth.
  • Adds op-reth/justfile with docs-install, docs-dev, docs-build, and docs-preview recipes.
  • Adds op-reth-docs-build CircleCI job in .circleci/continue/op-reth.yml that builds the docs via just docs-build.
  • Adds bun to mise.toml tooling.

Prompts used

I would like to port the documentation from op-reth from @../reth/ to @op-reth/ . Can you:
- Find all the documentation pages in @../reth/ that refer to crates inside @../reth/crates/optimism/ and move them to @op-reth/ docs.
- Can you make sure that the ported documentation compiles and work in the op-reth destination
- Can you add a circle CI job in @.circleci/continue/op-reth.yml that builds and deploys the documentation. A bit similar to what kona has (kona-docs-build in @.circleci/continue/kona.yml). Import the commands to build the docs from an op-reth justfile recipe.
Can you add bun install to mise.toml?

Test plan

  • Verify just docs-build succeeds in op-reth/
  • Verify the built site renders correctly (overview, OP Stack guide, CLI reference, FAQ)
  • Verify op-reth-docs-build CircleCI job passes

🤖 Generated with Claude Code

@theochap
Copy link
Member Author

Closes #18969

@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.7%. Comparing base (48a7a09) to head (6fc10e0).
⚠️ Report is 10 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop   #18968     +/-   ##
==========================================
- Coverage     75.8%    75.7%   -0.2%     
==========================================
  Files          700      700             
  Lines        71986    71986             
==========================================
- Hits         54574    54500     -74     
- Misses       17266    17342     +76     
+ Partials       146      144      -2     
Flag Coverage Δ
cannon-go-tests-64 66.4% <ø> (-0.9%) ⬇️
contracts-bedrock-tests 81.6% <ø> (ø)
unit 75.6% <ø> (-0.1%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 13 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 requested a review from a team as a code owner February 5, 2026 17:58
@theochap theochap requested a review from axelKingsley February 5, 2026 17:58
@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.

@theochap theochap changed the base branch from develop to theo/unify-workspaces February 5, 2026 18:02
@theochap theochap force-pushed the theo/unify-workspaces branch 16 times, most recently from 941f6f7 to 645c77f Compare February 9, 2026 20:17
@theochap theochap force-pushed the theo/unify-workspaces branch 5 times, most recently from 0b526a4 to 356de36 Compare February 10, 2026 04:32
Base automatically changed from theo/unify-workspaces to develop February 10, 2026 05:34
Copy link
Member

@sebastianst sebastianst left a comment

Choose a reason for hiding this comment

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

Isolated, moving over docs ✅

@theochap theochap enabled auto-merge February 10, 2026 18:42
@theochap theochap disabled auto-merge February 10, 2026 19:05
@theochap theochap enabled auto-merge February 10, 2026 19:06
@theochap theochap added this pull request to the merge queue Feb 10, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 10, 2026
@theochap theochap added this pull request to the merge queue Feb 10, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 10, 2026
@theochap theochap added this pull request to the merge queue Feb 10, 2026
@theochap theochap removed this pull request from the merge queue due to a manual request Feb 10, 2026
@theochap theochap added this pull request to the merge queue Feb 10, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Feb 10, 2026
@theochap theochap added this pull request to the merge queue Feb 11, 2026
Merged via the queue into develop with commit eaf92c9 Feb 11, 2026
123 checks passed
@theochap theochap deleted the push-xlmsvlxyospu branch February 11, 2026 15:23
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