mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-08 15:03:58 -05:00
chore(docs): move to docs from book (#17096)
Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
8
.github/workflows/book.yml
vendored
8
.github/workflows/book.yml
vendored
@@ -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
|
||||
|
||||
4
.github/workflows/lint.yml
vendored
4
.github/workflows/lint.yml
vendored
@@ -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:
|
||||
|
||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -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
|
||||
|
||||
2
Makefile
2
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.
|
||||
|
||||
@@ -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
|
||||
8
docs/vocs/.claude/settings.local.json
Normal file
8
docs/vocs/.claude/settings.local.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"permissions": {
|
||||
"allow": [
|
||||
"Bash(git checkout:*)"
|
||||
],
|
||||
"deny": []
|
||||
}
|
||||
}
|
||||
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user