docs: scope the no-Go claim to exclude the optional fixtures step - #14
Merged
Conversation
Found while running the published ceremony kit end to end from INSTALL.md: every required rehearsal step runs from the kit alone, but the optional evidence-upload transport test (steps 33-42) builds the operational-fixtures helper from proof-tool source, so it needs a Go toolchain and a proof-tool checkout at the approved tag. INSTALL.md's 'does not require Go or either source repository' claim and the .env PROOF_TOOL_ROOT placeholder did not say so, which strands a kit-only Machine 1 at step 33 with 'go: command not found' and an unexplained placeholder path. State the exception in INSTALL.md, document PROOF_TOOL_ROOT's real prerequisites in the machine-1 env example, and give the optional README section a prerequisites preamble that says the rehearsal is complete without it.
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
1 participant
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.
Found during the first end-to-end run of the published ceremony kit (v0.1.0-rehearsal.1) driven strictly from INSTALL.md → R2_SETUP.md → the rehearsal README, on three machines.
Everything required runs from the kit alone — but the optional evidence-upload transport test (steps 33–42) builds
mpc-rehearsal-operational-evidencefrom proof-tool source on Machine 1, so it needs a Go toolchain and aPROOF_TOOL_ROOTcheckout at the approved tag. Three places implied otherwise:machine-1/.env.example: thePROOF_TOOL_ROOTplaceholder never said what it must point at or that kit-only machines may leave it — now documents the approved-tag checkout + Go requirement and that steps 33–42 are skippable.For the record, the rest of the strict-docs run validated cleanly: kit download/verify/setup on all 3 machines, guided
setup-r2.sh(including its rejection of an insufficiently scoped inbox-parent token, and idempotent rerun), and steps 1–32 with zero interactive prompts via the credential-file flow.