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
No build/install/quickstart at all — nothing about the Dockerfile, the published image, or test-infra/; the examples list covers 6 of 11 examples.
AGENTS.md
The crate listing is 8 crates out of date: missing consensus, eth1wrap, featureset, frost, infosync, parsigex, priority, ssz; tree diagram omits third_party/ (load-bearing for charon interop in CI) and scripts/.
Cross-cutting: user-visible "Charon" branding in Pluto help text and crate docs — cli.rslong_about strings ("Verify that Charon can…", "Creates a local charon cluster configuration"), pluto-cluster/pluto-tracing module docs titled "# Charon …". Each needs a deliberate keep-or-rename decision (file/flag names like charon-enr-private-key are compatibility surface and should stay).
crates/cli/README.md's inverted parity table is already tracked by #584 — don't duplicate it here, but note cli.rs#L38 says "pluto-enr-private-key" while the actual default filename is charon-enr-private-key; the code comment is the wrong one.
Proposed change
One pass per file fixing the enumerated items; add a minimal Build/Run/Test quickstart to the README.
Summary
The top-level docs have drifted from the code in ways that actively mislead:
CONTRIBUTING.md
nix developprovides the Rust toolchain — it doesn't (Pin the Rust toolchain in the Nix dev shell #598); also omits that quality gates need a nightly rustfmt, that smoke tests need Go, and thatcargo test --all-featuresrequires a running Docker daemon (eth2api'sintegrationfeature uses testcontainers) — a contributor without Docker gets opaque failures.dhat = "latest", which isn't a valid version requirement.README.md
test-infra/; the examples list covers 6 of 11 examples.AGENTS.md
consensus,eth1wrap,featureset,frost,infosync,parsigex,priority,ssz; tree diagram omitsthird_party/(load-bearing for charon interop in CI) andscripts/.Cross-cutting: user-visible "Charon" branding in Pluto help text and crate docs —
cli.rslong_aboutstrings ("Verify that Charon can…", "Creates a local charon cluster configuration"),pluto-cluster/pluto-tracingmodule docs titled "# Charon …". Each needs a deliberate keep-or-rename decision (file/flag names likecharon-enr-private-keyare compatibility surface and should stay).crates/cli/README.md's inverted parity table is already tracked by #584 — don't duplicate it here, but notecli.rs#L38says "pluto-enr-private-key" while the actual default filename ischaron-enr-private-key; the code comment is the wrong one.Proposed change
One pass per file fixing the enumerated items; add a minimal Build/Run/Test quickstart to the README.