docs: a bootstrap page for dolos bootstrap stelae - #1217
Conversation
`docs/content/bootstrap/` had a page per bootstrap method — mithril, snapshot, relay, local — and none for stelae, which has shipped since `dolos-stelae-restore`. Everything an operator needed was in ADR-004, a design record addressed to implementers, and in `--help`. Adds `docs/content/bootstrap/stelae.mdx` in the shape the sibling pages have, and its LinkCard in the index grid. Covers the two `--source` spellings, `--point`, `--continue` as the resume, `sync.max_history` as the bound on what gets fetched, `[stelae.registry]` by link to the schema page, `--insecure`'s loopback-only scope, and `--scratch-dir`. Prose only: no new command surface, no new flag, no behavior change. Every flag and default is read off `dolos bootstrap stelae --help` as built from main. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan includes up to 2 reviews per rolling hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe PR adds a ChangesStele bootstrap documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change adds guidance for an existing bootstrap command without changing product behavior; no actionable merge-blocking risk remains. Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Plan:
plans/dolos-stelae-bootstrap-docs.md(Brain/txpipe)What changed
docs/content/bootstrap/stelae.mdx(new) — a bootstrap page fordolos bootstrap stelae, in the shape the four sibling pages already have.docs/content/bootstrap/index.mdx— itsLinkCardin the method grid.Prose only: no new command surface, no new flag, no behavior change.
The page covers the six things the plan named, because each is a thing an
operator gets wrong without it:
--sourcein both spellings (file://DIR,oci://HOST/PATH)--point:latestorepoch-N, and that a repository holds both--point--continueis the resume; a run without it starts over properly--continueis the resumesync.max_historybounds what is fetched[stelae.registry], by link rather than restatement--insecureis loopback / in-cluster only--insecure--scratch-diris documented too — it is the fourth flag in the subcommand's--helpand an operator staging a mainnet transfer needs it.Done criterion 2 — every claim read off the binary
cargo build --bin dolosat07d28245(main), then:Claims that are not in
--helpare read off the source rather than off a plan:--point/--insecure/--scratch-dirare ignored for afile://source rather than being an error" —
run()insrc/bin/dolos/bootstrap/stelae.rsdispatches
Source::Dirtorestore_dir, which takes none of them.file://./steleandfile://steleare relative;file:///absis absolute" —a_file_source_names_a_directoryin the same module.https://URL, or anoci://URL that names a tagare rejected at the command line" —
an_unusable_source_is_refused.sync.max_historyfloor are never fetched at all" —retain_history/planincrates/snapshot/src/restore.rs; unsetmax_historyreturns every epoch.
report()in the same module,including that
epochs:namessync.max_historyonly whenskipped_epochs > 0and
resumed:prints only whenoutlook.inherited > 0.adrs/004_stelae_snapshots.md, Consequences.Done criterion 3 — the docs site builds
Not verifiable in this repository, and reported rather than claimed.
docs/here is content only: no
package.json, noastro.config.*, and no docs job in.github/workflows/. The site is built elsewhere from this content.What was verified instead: the new page carries the same frontmatter keys as its
siblings (
title,sidebar.label,sidebar.order), imports onlyAsidefrom@astrojs/starlight/componentsand uses only that component, and itscross-document links follow the relative form already used across the tree
(
../bootstrap,../configuration/schema#sync-section,../configuration/schema#stelaeregistry-section). A reviewer with the sitecheckout should confirm the build and the two schema anchors resolve.
Judgment calls a reviewer should rule on
relay. The plan says the method mattersmore than the others do — but it also says which method a release recommends
is a product decision nobody has recorded, so the page does not take it by
ordering. Move it up if that decision has since been made.
oci://registry.example.com/dolos-snapshots/mainnet, a shape rather than anendpoint, because the official one is not provisioned yet
(
dolos-stelae-cloudflare-registry). Worth a follow-up edit once it exists.Out of scope by the plan's own scope decisions and untouched:
dolos snapshot publishdocs, ADR-004, and the legacybootstrap snapshotpage.🤖 Generated with Claude Code
Summary by CodeRabbit