You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A 2026-07-14 assessment of the Zebra book against the current codebase (v6.0.0) found six places where following the documentation as written either fails outright or misinforms the user.
Acceptance Criteria
book/src/user/supported-platforms.md:12 — correct the MSRV: the page says 1.89, but it is 1.88 for workspace/library crates (Cargo.toml) and 1.91 for the zebrad binary (zebrad/Cargo.toml); document the split
book/src/user/install.md:106-117 — remove or gate the "Optional Tor feature" build instructions: the tor feature is commented out in zebra-network/Cargo.toml and the build fails; align with book/src/user/troubleshooting.md:13, which correctly says Tor support is disabled
book/src/user/docker.md:39-50 — fix the "Custom Images" build command: docker build has no --env-file flag; use the --build-arg FEATURES=... form already shown at lines 67-72 of the same page
book/src/user/mining-docker.md — replace the non-functional bare -e MINER_ADDRESS=... with the working ZEBRA_MINING__MINER_ADDRESS env var (per book/src/user/docker.md:83); fix the address-prefix text (the example address is t3.../P2SH, not "t1… P2PKH"); mention the ready-made docker/mining/ compose stack
book/src/user/metrics.md — stop telling prebuilt-binary users to rebuild: prometheus is in the default release features (zebrad/Cargo.toml, confirmed by run.md:50); also update the Prometheus config mount path, which moved to docker/observability/prometheus/prometheus.yaml
book/src/dev/profiling-and-benchmarking.md:10-12 — fix or remove cargo build --profile profiling: no profiling profile exists in any workspace manifest
Context
A 2026-07-14 assessment of the Zebra book against the current codebase (v6.0.0) found six places where following the documentation as written either fails outright or misinforms the user.
Acceptance Criteria
book/src/user/supported-platforms.md:12— correct the MSRV: the page says 1.89, but it is 1.88 for workspace/library crates (Cargo.toml) and 1.91 for thezebradbinary (zebrad/Cargo.toml); document the splitbook/src/user/install.md:106-117— remove or gate the "Optional Tor feature" build instructions: thetorfeature is commented out inzebra-network/Cargo.tomland the build fails; align withbook/src/user/troubleshooting.md:13, which correctly says Tor support is disabledbook/src/user/docker.md:39-50— fix the "Custom Images" build command:docker buildhas no--env-fileflag; use the--build-arg FEATURES=...form already shown at lines 67-72 of the same pagebook/src/user/mining-docker.md— replace the non-functional bare-e MINER_ADDRESS=...with the workingZEBRA_MINING__MINER_ADDRESSenv var (perbook/src/user/docker.md:83); fix the address-prefix text (the example address ist3.../P2SH, not "t1… P2PKH"); mention the ready-madedocker/mining/compose stackbook/src/user/metrics.md— stop telling prebuilt-binary users to rebuild:prometheusis in the default release features (zebrad/Cargo.toml, confirmed byrun.md:50); also update the Prometheus config mount path, which moved todocker/observability/prometheus/prometheus.yamlbook/src/dev/profiling-and-benchmarking.md:10-12— fix or removecargo build --profile profiling: noprofilingprofile exists in any workspace manifestBlockers
None.
Related Issues / Advisories
docker/mining/stack mention overlaps lightly with [NU6.3] Add miner instructions to make their mining pools support v6 tx parsing #10909 (NU6.3 miner instructions) - this can still be completed as part of this issue.