From a33be2e02ee1dc9f6cfb568aafa120d00a84f72a Mon Sep 17 00:00:00 2001 From: Yash Atreya <44857776+yash-atreya@users.noreply.github.com> Date: Fri, 27 Jun 2025 18:18:45 +0530 Subject: [PATCH] chore(`docs`): move to docs from book (#17096) Co-authored-by: Claude --- .github/workflows/book.yml | 8 ++++---- .github/workflows/lint.yml | 4 ++-- .gitignore | 2 +- Makefile | 2 +- {book => docs}/cli/help.rs | 0 {book => docs}/cli/update.sh | 10 +++++----- docs/vocs/.claude/settings.local.json | 8 ++++++++ {book => docs}/vocs/CLAUDE.md | 0 {book => docs}/vocs/README.md | 0 {book => docs}/vocs/bun.lockb | Bin 311438 -> 312478 bytes .../vocs/docs/components/SdkShowcase.tsx | 0 .../vocs/docs/components/TrustedBy.tsx | 0 .../vocs/docs/pages/cli/SUMMARY.mdx | 0 {book => docs}/vocs/docs/pages/cli/cli.mdx | 0 {book => docs}/vocs/docs/pages/cli/op-reth.md | 0 {book => docs}/vocs/docs/pages/cli/reth.mdx | 0 .../vocs/docs/pages/cli/reth/config.mdx | 0 .../vocs/docs/pages/cli/reth/db.mdx | 0 .../vocs/docs/pages/cli/reth/db/checksum.mdx | 0 .../vocs/docs/pages/cli/reth/db/clear.mdx | 0 .../docs/pages/cli/reth/db/clear/mdbx.mdx | 0 .../pages/cli/reth/db/clear/static-file.mdx | 0 .../vocs/docs/pages/cli/reth/db/diff.mdx | 0 .../vocs/docs/pages/cli/reth/db/drop.mdx | 0 .../vocs/docs/pages/cli/reth/db/get.mdx | 0 .../vocs/docs/pages/cli/reth/db/get/mdbx.mdx | 0 .../pages/cli/reth/db/get/static-file.mdx | 0 .../vocs/docs/pages/cli/reth/db/list.mdx | 0 .../vocs/docs/pages/cli/reth/db/path.mdx | 0 .../vocs/docs/pages/cli/reth/db/stats.mdx | 0 .../vocs/docs/pages/cli/reth/db/version.mdx | 0 .../vocs/docs/pages/cli/reth/debug.mdx | 0 .../docs/pages/cli/reth/debug/build-block.mdx | 0 .../docs/pages/cli/reth/debug/execution.mdx | 0 .../pages/cli/reth/debug/in-memory-merkle.mdx | 0 .../vocs/docs/pages/cli/reth/debug/merkle.mdx | 0 .../vocs/docs/pages/cli/reth/download.mdx | 0 .../vocs/docs/pages/cli/reth/dump-genesis.mdx | 0 .../vocs/docs/pages/cli/reth/import-era.mdx | 0 .../vocs/docs/pages/cli/reth/import.mdx | 0 .../vocs/docs/pages/cli/reth/init-state.mdx | 0 .../vocs/docs/pages/cli/reth/init.mdx | 0 .../vocs/docs/pages/cli/reth/node.mdx | 0 .../vocs/docs/pages/cli/reth/p2p.mdx | 0 .../vocs/docs/pages/cli/reth/p2p/body.mdx | 0 .../vocs/docs/pages/cli/reth/p2p/header.mdx | 0 .../vocs/docs/pages/cli/reth/p2p/rlpx.mdx | 0 .../docs/pages/cli/reth/p2p/rlpx/ping.mdx | 0 .../vocs/docs/pages/cli/reth/prune.mdx | 0 .../vocs/docs/pages/cli/reth/recover.mdx | 0 .../pages/cli/reth/recover/storage-tries.mdx | 0 .../vocs/docs/pages/cli/reth/stage.mdx | 0 .../vocs/docs/pages/cli/reth/stage/drop.mdx | 0 .../vocs/docs/pages/cli/reth/stage/dump.mdx | 0 .../cli/reth/stage/dump/account-hashing.mdx | 0 .../pages/cli/reth/stage/dump/execution.mdx | 0 .../docs/pages/cli/reth/stage/dump/merkle.mdx | 0 .../cli/reth/stage/dump/storage-hashing.mdx | 0 .../vocs/docs/pages/cli/reth/stage/run.mdx | 0 .../vocs/docs/pages/cli/reth/stage/unwind.mdx | 0 .../cli/reth/stage/unwind/num-blocks.mdx | 0 .../pages/cli/reth/stage/unwind/to-block.mdx | 0 .../pages/cli/reth/test-vectors/tables.mdx | 0 .../vocs/docs/pages/exex/hello-world.mdx | 0 .../vocs/docs/pages/exex/how-it-works.mdx | 0 .../vocs/docs/pages/exex/overview.mdx | 0 .../vocs/docs/pages/exex/remote.mdx | 0 .../vocs/docs/pages/exex/tracking-state.mdx | 0 {book => docs}/vocs/docs/pages/index.mdx | 0 .../vocs/docs/pages/installation/binaries.mdx | 0 .../installation/build-for-arm-devices.mdx | 0 .../vocs/docs/pages/installation/docker.mdx | 0 .../vocs/docs/pages/installation/overview.mdx | 0 .../docs/pages/installation/priorities.mdx | 0 .../vocs/docs/pages/installation/source.mdx | 0 .../docs/pages/introduction/contributing.mdx | 0 .../vocs/docs/pages/introduction/why-reth.mdx | 0 .../vocs/docs/pages/jsonrpc/admin.mdx | 0 .../vocs/docs/pages/jsonrpc/debug.mdx | 0 .../vocs/docs/pages/jsonrpc/eth.mdx | 0 .../vocs/docs/pages/jsonrpc/intro.mdx | 0 .../vocs/docs/pages/jsonrpc/net.mdx | 0 .../vocs/docs/pages/jsonrpc/rpc.mdx | 0 .../vocs/docs/pages/jsonrpc/trace.mdx | 0 .../vocs/docs/pages/jsonrpc/txpool.mdx | 0 .../vocs/docs/pages/jsonrpc/web3.mdx | 0 {book => docs}/vocs/docs/pages/overview.mdx | 0 .../vocs/docs/pages/run/configuration.mdx | 0 .../vocs/docs/pages/run/ethereum.mdx | 0 .../docs/pages/run/ethereum/snapshots.mdx | 0 {book => docs}/vocs/docs/pages/run/faq.mdx | 0 .../vocs/docs/pages/run/faq/ports.mdx | 0 .../vocs/docs/pages/run/faq/profiling.mdx | 0 .../vocs/docs/pages/run/faq/pruning.mdx | 0 .../docs/pages/run/faq/sync-op-mainnet.mdx | 0 .../vocs/docs/pages/run/faq/transactions.mdx | 0 .../docs/pages/run/faq/troubleshooting.mdx | 0 .../vocs/docs/pages/run/monitoring.mdx | 0 .../vocs/docs/pages/run/networks.mdx | 0 .../vocs/docs/pages/run/opstack.mdx | 0 .../pages/run/opstack/op-mainnet-caveats.mdx | 0 .../vocs/docs/pages/run/overview.mdx | 0 .../vocs/docs/pages/run/private-testnets.mdx | 0 .../docs/pages/run/system-requirements.mdx | 0 .../pages/sdk/custom-node/modifications.mdx | 0 .../pages/sdk/custom-node/prerequisites.mdx | 0 .../docs/pages/sdk/examples/modify-node.mdx | 0 .../sdk/examples/standalone-components.mdx | 0 .../vocs/docs/pages/sdk/node-components.mdx | 0 .../pages/sdk/node-components/consensus.mdx | 0 .../docs/pages/sdk/node-components/evm.mdx | 0 .../pages/sdk/node-components/network.mdx | 0 .../docs/pages/sdk/node-components/pool.mdx | 0 .../docs/pages/sdk/node-components/rpc.mdx | 0 .../vocs/docs/pages/sdk/overview.mdx | 0 .../vocs/docs/pages/sdk/typesystem/block.mdx | 0 .../sdk/typesystem/transaction-types.mdx | 0 {book => docs}/vocs/docs/public/alchemy.png | Bin {book => docs}/vocs/docs/public/coinbase.png | Bin {book => docs}/vocs/docs/public/flashbots.png | Bin {book => docs}/vocs/docs/public/logo.png | Bin .../vocs/docs/public/remote_exex.png | Bin {book => docs}/vocs/docs/public/reth-prod.png | Bin {book => docs}/vocs/docs/public/succinct.png | Bin .../vocs/docs/snippets/sources/Cargo.toml | 0 .../sources/exex/hello-world/Cargo.toml | 0 .../sources/exex/hello-world/src/bin/1.rs | 0 .../sources/exex/hello-world/src/bin/2.rs | 0 .../sources/exex/hello-world/src/bin/3.rs | 0 .../snippets/sources/exex/remote/Cargo.toml | 0 .../snippets/sources/exex/remote/build.rs | 0 .../sources/exex/remote/proto/exex.proto | 0 .../sources/exex/remote/src/consumer.rs | 0 .../snippets/sources/exex/remote/src/exex.rs | 0 .../sources/exex/remote/src/exex_1.rs | 0 .../sources/exex/remote/src/exex_2.rs | 0 .../sources/exex/remote/src/exex_3.rs | 0 .../sources/exex/remote/src/exex_4.rs | 0 .../snippets/sources/exex/remote/src/lib.rs | 0 .../sources/exex/tracking-state/Cargo.toml | 0 .../sources/exex/tracking-state/src/bin/1.rs | 0 .../sources/exex/tracking-state/src/bin/2.rs | 0 {book => docs}/vocs/docs/styles.css | 0 {book => docs}/vocs/links-report.json | 0 {book => docs}/vocs/package.json | 2 +- {book => docs}/vocs/redirects.config.ts | 0 .../vocs/scripts/build-cargo-docs.sh | 0 {book => docs}/vocs/scripts/check-links.ts | 0 .../vocs/scripts/generate-redirects.ts | 0 .../vocs/scripts/inject-cargo-docs.ts | 0 {book => docs}/vocs/sidebar.ts | 0 {book => docs}/vocs/tsconfig.json | 0 {book => docs}/vocs/vocs.config.ts | 0 153 files changed, 22 insertions(+), 14 deletions(-) rename {book => docs}/cli/help.rs (100%) rename {book => docs}/cli/update.sh (60%) create mode 100644 docs/vocs/.claude/settings.local.json rename {book => docs}/vocs/CLAUDE.md (100%) rename {book => docs}/vocs/README.md (100%) rename {book => docs}/vocs/bun.lockb (95%) rename {book => docs}/vocs/docs/components/SdkShowcase.tsx (100%) rename {book => docs}/vocs/docs/components/TrustedBy.tsx (100%) rename {book => docs}/vocs/docs/pages/cli/SUMMARY.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/cli.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/op-reth.md (100%) rename {book => docs}/vocs/docs/pages/cli/reth.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/config.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/checksum.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/clear.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/clear/mdbx.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/clear/static-file.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/diff.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/drop.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/get.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/get/mdbx.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/get/static-file.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/list.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/path.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/stats.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/db/version.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/debug.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/debug/build-block.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/debug/execution.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/debug/in-memory-merkle.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/debug/merkle.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/download.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/dump-genesis.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/import-era.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/import.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/init-state.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/init.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/node.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/p2p.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/p2p/body.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/p2p/header.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/p2p/rlpx.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/p2p/rlpx/ping.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/prune.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/recover.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/recover/storage-tries.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/drop.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/dump.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/dump/account-hashing.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/dump/execution.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/dump/merkle.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/dump/storage-hashing.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/run.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/unwind.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/unwind/num-blocks.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/stage/unwind/to-block.mdx (100%) rename {book => docs}/vocs/docs/pages/cli/reth/test-vectors/tables.mdx (100%) rename {book => docs}/vocs/docs/pages/exex/hello-world.mdx (100%) rename {book => docs}/vocs/docs/pages/exex/how-it-works.mdx (100%) rename {book => docs}/vocs/docs/pages/exex/overview.mdx (100%) rename {book => docs}/vocs/docs/pages/exex/remote.mdx (100%) rename {book => docs}/vocs/docs/pages/exex/tracking-state.mdx (100%) rename {book => docs}/vocs/docs/pages/index.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/binaries.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/build-for-arm-devices.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/docker.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/overview.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/priorities.mdx (100%) rename {book => docs}/vocs/docs/pages/installation/source.mdx (100%) rename {book => docs}/vocs/docs/pages/introduction/contributing.mdx (100%) rename {book => docs}/vocs/docs/pages/introduction/why-reth.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/admin.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/debug.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/eth.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/intro.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/net.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/rpc.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/trace.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/txpool.mdx (100%) rename {book => docs}/vocs/docs/pages/jsonrpc/web3.mdx (100%) rename {book => docs}/vocs/docs/pages/overview.mdx (100%) rename {book => docs}/vocs/docs/pages/run/configuration.mdx (100%) rename {book => docs}/vocs/docs/pages/run/ethereum.mdx (100%) rename {book => docs}/vocs/docs/pages/run/ethereum/snapshots.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/ports.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/profiling.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/pruning.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/sync-op-mainnet.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/transactions.mdx (100%) rename {book => docs}/vocs/docs/pages/run/faq/troubleshooting.mdx (100%) rename {book => docs}/vocs/docs/pages/run/monitoring.mdx (100%) rename {book => docs}/vocs/docs/pages/run/networks.mdx (100%) rename {book => docs}/vocs/docs/pages/run/opstack.mdx (100%) rename {book => docs}/vocs/docs/pages/run/opstack/op-mainnet-caveats.mdx (100%) rename {book => docs}/vocs/docs/pages/run/overview.mdx (100%) rename {book => docs}/vocs/docs/pages/run/private-testnets.mdx (100%) rename {book => docs}/vocs/docs/pages/run/system-requirements.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/custom-node/modifications.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/custom-node/prerequisites.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/examples/modify-node.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/examples/standalone-components.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components/consensus.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components/evm.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components/network.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components/pool.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/node-components/rpc.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/overview.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/typesystem/block.mdx (100%) rename {book => docs}/vocs/docs/pages/sdk/typesystem/transaction-types.mdx (100%) rename {book => docs}/vocs/docs/public/alchemy.png (100%) rename {book => docs}/vocs/docs/public/coinbase.png (100%) rename {book => docs}/vocs/docs/public/flashbots.png (100%) rename {book => docs}/vocs/docs/public/logo.png (100%) rename {book => docs}/vocs/docs/public/remote_exex.png (100%) rename {book => docs}/vocs/docs/public/reth-prod.png (100%) rename {book => docs}/vocs/docs/public/succinct.png (100%) rename {book => docs}/vocs/docs/snippets/sources/Cargo.toml (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/hello-world/Cargo.toml (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/hello-world/src/bin/1.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/hello-world/src/bin/2.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/hello-world/src/bin/3.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/Cargo.toml (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/build.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/proto/exex.proto (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/consumer.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/exex.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/exex_1.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/exex_2.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/exex_3.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/exex_4.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/remote/src/lib.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/tracking-state/Cargo.toml (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/tracking-state/src/bin/1.rs (100%) rename {book => docs}/vocs/docs/snippets/sources/exex/tracking-state/src/bin/2.rs (100%) rename {book => docs}/vocs/docs/styles.css (100%) rename {book => docs}/vocs/links-report.json (100%) rename {book => docs}/vocs/package.json (96%) rename {book => docs}/vocs/redirects.config.ts (100%) rename {book => docs}/vocs/scripts/build-cargo-docs.sh (100%) rename {book => docs}/vocs/scripts/check-links.ts (100%) rename {book => docs}/vocs/scripts/generate-redirects.ts (100%) rename {book => docs}/vocs/scripts/inject-cargo-docs.ts (100%) rename {book => docs}/vocs/sidebar.ts (100%) rename {book => docs}/vocs/tsconfig.json (100%) rename {book => docs}/vocs/vocs.config.ts (100%) diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index fb04b785ce..0c0bf1e053 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -24,7 +24,7 @@ jobs: - name: Install Playwright browsers # Required for rehype-mermaid to render Mermaid diagrams during build run: | - cd book/vocs/ + cd docs/vocs/ bun i npx playwright install --with-deps chromium @@ -32,11 +32,11 @@ jobs: uses: dtolnay/rust-toolchain@nightly - name: Build docs - run: cd book/vocs && bash scripts/build-cargo-docs.sh + run: cd docs/vocs && bash scripts/build-cargo-docs.sh - name: Build Vocs run: | - cd book/vocs/ && bun run build + cd docs/vocs/ && bun run build echo "Vocs Build Complete" - name: Setup Pages @@ -45,7 +45,7 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - path: "./book/vocs/docs/dist" + path: "./docs/vocs/docs/dist" deploy: # Only deploy if a push to main diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 7a167da8b1..2d30f5b69b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -184,8 +184,8 @@ jobs: - run: cargo build --bin reth --workspace --features ethereum env: RUSTFLAGS: -D warnings - - run: ./book/cli/update.sh target/debug/reth - - name: Check book changes + - run: ./docs/cli/update.sh target/debug/reth + - name: Check docs changes run: git diff --exit-code codespell: diff --git a/.gitignore b/.gitignore index e4ca0420ba..7335978db1 100644 --- a/.gitignore +++ b/.gitignore @@ -55,7 +55,7 @@ rustc-ice-* book/sources/Cargo.lock # vocs node_modules -book/vocs/node_modules +docs/vocs/node_modules # Cargo chef recipe file recipe.json diff --git a/Makefile b/Makefile index c9c09a6171..fdfd0b6ee3 100644 --- a/Makefile +++ b/Makefile @@ -368,7 +368,7 @@ db-tools: ## Compile MDBX debugging tools. .PHONY: update-book-cli update-book-cli: build-debug ## Update book cli documentation. @echo "Updating book cli doc..." - @./book/cli/update.sh $(CARGO_TARGET_DIR)/debug/reth + @./docs/cli/update.sh $(CARGO_TARGET_DIR)/debug/reth .PHONY: profiling profiling: ## Builds `reth` with optimisations, but also symbols. diff --git a/book/cli/help.rs b/docs/cli/help.rs similarity index 100% rename from book/cli/help.rs rename to docs/cli/help.rs diff --git a/book/cli/update.sh b/docs/cli/update.sh similarity index 60% rename from book/cli/update.sh rename to docs/cli/update.sh index 01593bfb79..b75dbd789a 100755 --- a/book/cli/update.sh +++ b/docs/cli/update.sh @@ -1,16 +1,16 @@ #!/usr/bin/env bash set -eo pipefail -BOOK_ROOT="$(dirname "$(dirname "$0")")" -RETH=${1:-"$(dirname "$BOOK_ROOT")/target/debug/reth"} -VOCS_PAGES_ROOT="$BOOK_ROOT/vocs/docs/pages" +DOCS_ROOT="$(dirname "$(dirname "$0")")" +RETH=${1:-"$(dirname "$DOCS_ROOT")/target/debug/reth"} +VOCS_PAGES_ROOT="$DOCS_ROOT/vocs/docs/pages" echo "Generating CLI documentation for reth at $RETH" -echo "Using book root: $BOOK_ROOT" +echo "Using docs root: $DOCS_ROOT" echo "Using vocs pages root: $VOCS_PAGES_ROOT" cmd=( "$(dirname "$0")/help.rs" - --root-dir "$BOOK_ROOT/" + --root-dir "$DOCS_ROOT/" --root-indentation 2 --root-summary --verbose diff --git a/docs/vocs/.claude/settings.local.json b/docs/vocs/.claude/settings.local.json new file mode 100644 index 0000000000..c2dc67502f --- /dev/null +++ b/docs/vocs/.claude/settings.local.json @@ -0,0 +1,8 @@ +{ + "permissions": { + "allow": [ + "Bash(git checkout:*)" + ], + "deny": [] + } +} \ No newline at end of file diff --git a/book/vocs/CLAUDE.md b/docs/vocs/CLAUDE.md similarity index 100% rename from book/vocs/CLAUDE.md rename to docs/vocs/CLAUDE.md diff --git a/book/vocs/README.md b/docs/vocs/README.md similarity index 100% rename from book/vocs/README.md rename to docs/vocs/README.md diff --git a/book/vocs/bun.lockb b/docs/vocs/bun.lockb similarity index 95% rename from book/vocs/bun.lockb rename to docs/vocs/bun.lockb index bc5c53c3de1c23052b64668edb1dabe914f230ad..a975dd0d492b53cbc4e9cd653281dcc371755ef8 100755 GIT binary patch delta 4020 zcmdUyiC0ud7Kh(^-83}VU_e_y5LrwFrDfAbQG&=sql{Zn!IhQN%YG52g;qt@~Bgt*ZN~Zgs6% z>QYkZQl#-;RycIMwqUq@<8J@LVV@@?pZjU}o<(_~RU;$)457jLGRG>pK&f%fBrmD) z>fXF?wIS$*AUFs@!MxP;)J$DY&T>CNP(pVHS3~BaJ?Z%`1)&>cBP8)pP)~f(D?v~} zs@g32k`_U*hd%h3MV3PE1U>AvrN6$_GF}$iW88=W&o>qWX^_;>YRKC0e>xP17`QXq z?Ko30zS|e-s1=>3rllCW_Vt*x08 z5BxN>xwF(G>Lmf z2cvhGRvCc-BQc<4)WvI+3!#NWvo&rB(kk~ti-6`}Y|?0zPoTv?6OBz%!tLNFsTJ#Z7C{>fO=0w&8g9oG z8?%u%Xi*j;{j|za@b*M#GIO^r&}apAX6-iDKw|i%CovTqd zSu3TytC)Omj+*_`S?p}UCKHlu>Ayvakb3AOlQ}0zdJ3chG7VA&nZbD`Bqfr>bGY77 zQvdn9eJ-zu9ANH{$2;cpijGo3$HknJBtuIovi=?Mf4u-xf{S?hRaAZb4^QhSU*4vl zt`m0V-btSKzl?aIw{%)5~OcK*w}rC!c1gDM^+N$$<}pZ6Q(r8&L2t-hrt zB{M9scHPd`xBqVJ>HF2PuNOYAsZ6b2b|4!r6@_-EcF1bhU?)vtz3n7bY}AT|vCeVT zPb)l!k3H1CWTl&j)9p3=>vg>|pjZTWAZj^)PGb`6jnz|JvmP62?}KGw$AWT2SBG-Zo`GbYyaDo zKIKP>KdWMkm6EIBY^aN=AtvMao@Ze*w~W{}QaPgbeBTYF`sT=kEk`N?XFiQz&%6Uq zlpQZ0J2pG9Y}WWlwQ%N`LZb^!Rj13(?y-~ce96Toi-uCOmV0lXuys}sOg z_MX6xDu8J!fCg5k0*H46P&oozX9GaIm#mitwx;*7#np_w7Vo#c?B2pOVuiZeTu^<)95nls$4!hYWFU!38B z6pCr)NT)f&Eh@a`?apvU6At6{XnRT&VR20hQM4Q++7x8R5t#xiP4WU~PAJdfv95+X zL&uFPq;giv+kFByhqFtZIfKpRtPYHZb3rzI$6fO)Z`cKJ8OoHda@G~)IKDdid{k5; zKS8F{z*#qxop`%zoVkK2IlIo88<+@&`51&79J&LhaM#@AtUFjRpY<)yJiyA(nOuIG zGf$M`dAml=dVq!V#Wiu}1vU&zCy(DTGx)zJ6uO(py?1#-Z@y^FetY7`gHu zXTB(>b9SFIKd@Fl@B_|zfyHCeIRX4fcVv zJlZHo`iE>lgB0mWw|yw~%M{3|$kULgBhNriG_7fnTtw9(lqnw2PZ*tP-!^pf zZM`9l6rJfP(b1u!LPtYyYihqKwTseW8`Fo|lA~yo4Vr6GHA%xoF~>CFj1<20q*W2NHp^i5nx(HCifB6^ z{aGPn+6Kv6yk$zgC(ZRV&~hmnQ0So0Lt%x&5``SnDSVtmrszNikWTs$G zK_*U&q65jx$P@wSz|#SzLrMLqFJ(HoKTCL1#GpV2kq+4bh2>K&Kh08PvH-SDCW}!7 zYl1YPg6Wn__WVeQ_2<9!7rP`*57mTfunnv)66+6p)P!k*HNopEWnC4)L1cuTKOyTb zy0dYWGPh9c%g6eFK>H9h!X~r6fvisn)CAKcg3SF5)~As5MS<%6mX6lPk@byXoIVMHM6x~s=0=j0KIhHeaN4EB7WUANvs6v z1`idmV<%O+ZMKob#~?WScto+xDw%8d0K5tigbIS~U$g{#(M2wa zY7oTUf-LrZm29IF_L@bVl)3h|zQSf^`3;G3a0LwtvTiP0 zeNe7;$kffB9hj4po1MLo?foe8VB-$S-Pm|vxgRS#BoAl(S}~on7-TWOpwwb9*)1@aR>jT-U-SVFQZG62{?k$F~ xy?y1rtm%+ktv2tpjvbTIQgc(;&>ESCDgUs%hn$@`DF24_OqScS%}3>}{{b%xwgUhF delta 3463 zcmd6pi&xag6~})s9zS4RKt&#cfKX9nSw!8f#)xRuQ`96D3r0m(P@cldLLw>!8Li|<)FOFvURWLme4KL0bN(NZmcf6+`DPWxw)Bw`Q47Tfn$n5 z<$7hx2L(zJp-E&$HJkfeUr*>6#ezw_Uv53%B=-rPTcI{|2 z(Cd4xKl+6v-s=;DVNf$3IEIaaPQx!gc9?}f5d;srxnr77?+b$0f7$QP88*|;SmX8e zz|Ye!jSukk%}XAsZLOQ1T`vt>ta#gdabDg=vC86FQJVhoq&3F_BV7+KUDp1$l7WKw z>Y!=Xo*46fvu@cw(ZgCf!JtltyUCbewECnN)Gg3vLzAtQGYo1Qw3neNR-agdIus8w z)o%G(t3l0&W`yQuZP6Rl-Owi4$GtYgpm`205gLWi)4D+yZ9T4YSEu$mY}~CaaR#-U zYZz}bxQs&-Ub1RZCad`*VXTYYpBiWh(BJ`95fP)`+gHIDH3b@Zhxuxa?p#r4KWu3GL$|OAG3OD@mmh?=nQ|k(S6@)T#cCiQPE3lGw;bdrK*7wkm1ZW^XBJZZo|MUX&&O(A1}$O1dyQ zVSeeM&LwN<7I*D@y8EK}O*H=IgytyyS@ zS@hH6;jCN5LeJeX?^nN^*O+;^2mULlp&I-S$yKDD6yE`SfI{wzHZtN2e$$!pI3oZP|gSL{BxU_cuFh-c4Low?NyyAUZ5AWLI_XsE4n7 z@-jjy3Io~!v}f5uPlO@W6Ja>&iMX6+suzH}7r-hnfEM;o0tX2MYXB~?Yz;t`2H-4# zODtdzfd3$X(m?=iteHR)ffy~oWmcjESfd5FPT(rLOwo_>mNd30K9cR%Hhq#5{GNyY zk|SDUFSC1X(zLRHpB;tX%Q1A(X21z&FHW6CIFsr)x1o*yp5t5=zT}M5O`M(J%ms{O zD)pRE5@t|`Ae0FwIi#F9zzt7v<_`8Td4$ry8BTNIF}G{v3`evu-Z7!j1V-IB#)Sm( z66G|vqX(l?fck0Ih*+OK2SOIl*fW6CIS4g}vvYPsLC}Kba(13Ge0qdD&Mtt_dOoOI zc@!>kJ72K3AX91OY%t{HGX8Y*R!AIz+J#ExYtDv3)^fWx&M1pj&c5M{4j&PW0&$r$ zf527cq3^pB)P9gu6vk=I1 zpi*?(IU51_O)!e&cMeu2ghI&&q)^`EhGCEkIQyQnaIgn_;ai-I1WSd}6w2G2ML?bh zMv?5`EE4iaFpAn8&VB`Xih}n~Pt?ibD9E$;B6q>?6QWQH_(rW* z$_$z>4s{L$a^MMP;~bORS(%3S(=oNyCHbvk;GMvlQ)O)Fr5k zP?w>m+4fzN28%w+A+JQGli?6-Gi)u_r5{Aw$#13EqAz6>We{ZyWyoO{TgZ3PfM^T- zUh)!MEI@DA;%-T^M6t+La$9;!6pPvO4r!gsU*SzAd;5+Q9lRD+g{ZWV=xa@zhrZsl zUkcdSJCZ>|*lA{FKAqC}-~Cr@m7P*~^3W7t7gdA6%w7q5%c+g#n`o;p_BAP0Io@2}2_BU4m4%s3vmQrrfS zZ{^M#rX;4t>EiGcoL6G!T@*c-Rfk;?$(AlEg`y0Uj?q2$n)}l|F|yeMCymTB(a1|Ym~!=e}N91x#bxP>rZUgR=Y@IH3$wqT-4bg z8fE{WcIY@u%Hup9-XAk_h$4w+K#=6+qu9Pid7E^vkIid>q4Vm#e09W>1W&CItHW)? zMF?jbn&bd+6x-G$Z(}(KfJa4x<1O?wviFUcpk4+5gs=|k7A4^5j0X`Ed$u+?G82-bH*F|wm|ieF?rmW?O# zglvn+lx~Sl&&w{(PB7