docs: clarify image tag descriptions#498
Conversation
🤖 Claude Code ReviewAll checks pass. This is a clean, well-formed documentation PR. Here's my review: Review: PR 498 — docs: clarify image tags, add spec-deviations page to bookThis is a documentation-only PR (no code changes), so the usual consensus-layer/correctness/security concerns don't apply. I verified the factual claims in the new content against the current codebase. Verification of
|
🤖 Kimi Code ReviewGeneral: Documentation-only PR. Good practice documenting spec deviations explicitly—critical for consensus client auditability. Item 1: Fragile line number references
Item 2: Missing equivalence verification details Item 3: Consensus parameter exposure
Item 4: Consistency check Item 5: Documentation structure Conclusion: Approving with minor suggestions. The explicit documentation of deviations from leanSpec is essential for consensus safety. Address Item 1 (line number fragility) before merge if possible, or accept the maintenance burden. Automated review by Kimi (Moonshot AI) · kimi-k2.5 · custom prompt |
🤖 Codex Code Review
Beyond those documentation mismatches, I did not see executable-path changes in this PR, so I have no code correctness or security findings against the Rust implementation itself. I did not run tests, since the diff is docs-only. Automated review by OpenAI Codex · gpt-5.4 · custom prompt |
Greptile SummaryThis is a documentation consistency pass that clarifies image-tag semantics, adds the missing
Confidence Score: 5/5Pure documentation update with no code changes; safe to merge. All referenced source line numbers were verified accurate against the current codebase. The only observation is a cosmetic inconsistency in RELEASE.md where the devnetX inline examples still list devnet3/devnet4 while the docker-pull example was bumped to devnet5. RELEASE.md — the devnetX inline examples are slightly stale relative to the updated docker-pull line.
|
| Filename | Overview |
|---|---|
| README.md | Clarifies latest ("latest stable") and unstable ("built from the latest main commit") tag descriptions; no functional issues. |
| RELEASE.md | Updates latest/unstable bullet descriptions and bumps the docker-pull example from devnet3 to devnet5; the devnetX inline examples still list only devnet3, devnet4 while devnet5 is current — minor inconsistency. |
| docs/SUMMARY.md | Adds spec_deviations.md under a new Development section so the page renders in the mdBook; change is straightforward and correct. |
| docs/spec_deviations.md | New page describing async aggregation and attestation scoring deviations; all referenced line numbers verified accurate against current source (aggregation.rs:33/504/519, lib.rs:47, block_builder.rs:170/473/517, block.rs:109). |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
main[main branch commit] -->|CI build| unstable[ghcr.io/.../ethlambda:unstable]
unstable -->|tested & promoted| devnetX["ghcr.io/.../ethlambda:devnetX (e.g. devnet5)"]
devnetX -->|aliased| latest[ghcr.io/.../ethlambda:latest]
main -->|every commit| sha[ghcr.io/.../ethlambda:sha-XXXXXXX]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
main[main branch commit] -->|CI build| unstable[ghcr.io/.../ethlambda:unstable]
unstable -->|tested & promoted| devnetX["ghcr.io/.../ethlambda:devnetX (e.g. devnet5)"]
devnetX -->|aliased| latest[ghcr.io/.../ethlambda:latest]
main -->|every commit| sha[ghcr.io/.../ethlambda:sha-XXXXXXX]
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
RELEASE.md:26
The `devnetX` examples in the bullet still only list `devnet3` and `devnet4`, but the docker-pull example just below was bumped to `devnet5` (the current devnet). Readers who associate "at the time of writing" with these inline examples may be confused about whether devnet5 is supported by this tag.
```suggestion
- `devnetX` - the latest stable image built with `devnetX` support (e.g. `devnet4`, `devnet5`)
```
Reviews (1): Last reviewed commit: "docs: clarify image tags, add spec-devia..." | Re-trigger Greptile
Clarify that unstable is built from the latest main commit and that latest/devnetX are the latest *stable* devnet images (README, RELEASE). Bump the stale devnet3 'at the time of writing' and docker pull examples to devnet5, the current devnet.
a649d34 to
b577e3e
Compare
Greptile flagged the inline devnetX examples still listed devnet3/devnet4 while the docker-pull example was bumped to devnet5.
Summary
Clarifies the Docker image-tag wording in
README.mdandRELEASE.md:unstableis built from the latestmaincommit.latest/devnetXare the latest stable devnet images.devnet3"at the time of writing" anddocker pullexamples todevnet5(the current devnet).Notes
Cargo.tomlleansigdevnet4branch (real dependency), thedevnet3/devnet4test-ignore comment inencoding.rs, and the README "Older devnets" list (devnet1-4are correctly the older ones;devnet5is current).docs/spec_deviations.mdpage (and itsSUMMARY.mdindex entry) was split into docs: add spec deviations page #499.