docs: align documentation with the create-snapshots + bootstrap pipeline#46
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation review against the current state of the code, conforming to the org docs standard.
What was inaccurate
The docs were last aligned at 223437b, before the producer migrated to upstream
amaru create-snapshots+amaru bootstrap(187359f) and before db-analyser returned to the image / the nonces.json gate was dropped (dadfc9a). As a result:ledger-state-emitter->amaru convert-ledger-state->header-extractor get-header-> nonce tail rewrite ->amaru import-ledger-state/import-headers/import-nonces). The actual pipeline in scripts/bootstrap-producer.sh is: preflight via header-extractor -> targets.json/snapshots.json from the chain's own block list ->amaru create-snapshots-> era-history sidecars ->amaru bootstrap-> atomicmv -Tcommit.nonces.jsonandheaders/; both are baked intochain.<network>.dbbyamaru bootstrapnow (the layout is ledger db + chain db +snapshots/<network>/+era-history.json).+ ledger-state-emitter @,+ amaru import-ledger-state) do not exist in the script; rc=9 was described as "import commands failed" (it isamaru bootstrap), and rc=6 was missing from the failure table.bootstrap-producer-synthesized,antithesis-short-epoch-samples,antithesis-short-epoch-golden) asserted convert/import behaviour that nix/checks.nix no longer contains.What changed
securityLevel: "strict"in mermaid-init.js, raw<scratch-out>text in labels gets sanitized away as a tag.Verification
nix develop github:paolino/dev-assets?dir=mkdocs -c mkdocs build --strictpasses with no warnings.Out of scope, noted for follow-up
site/(50 files) is a stale committed mkdocs build (pre-dates the current nav; Pages deploys via gh-deploy, so it is dead weight) andtmp/smoke-out/(100 files) is committed smoke-test output including binary chain-db chunks. Both left untouched here as non-docs deletions.nix/checks.nixwrites a METADATA.md into the short-epoch corpus stating "synthesized slots: 720" while db-synthesizer is invoked with-s 3000; not touched because it is generated by nix code.