docs(README): Better explain Docker image stages and proposal files #240
Conversation
|
README.md
Outdated
| | PREPARE | chain software upgrade proposals | submits the proposal, votes on it, runs to halt for the next stage | | ||
| | EXECUTE | chain software upgrade proposals | starts `agd` with the new SDK, letting its upgrade handler upgrade the chain | | ||
| | EVAL | other proposals | submits the proposal, votes on it, and begin executing. Does not guarantee the eval will finish but does wait several blocks to give it a chance. | | ||
| | USE | proposals | Perform actions to update the chain state, to persist through the chain history. E.g. adding a vault that will be tested again in the future. | |
There was a problem hiding this comment.
consider "all proposals".
also consider referencing the flow diagram: https://github.com/Agoric/agoric-3-proposals/tree/main/packages/synthetic-chain#design
There was a problem hiding this comment.
Moved the flow diagram to the top-level README.
gibson042
force-pushed
the
gibson-2025-05-readme-improvements
branch
3 times, most recently
from
6764e83 to
90780ac
Compare
| AP -- Yes ----> NP | ||
| AP -- No ----> END[DEFAULT last use] | ||
| ``` | ||
| [dockerfileGen.ts](./src/cli/dockerfileGen.ts) generates a Dockerfile for the multi-stage build described in the [repository README](../../README.md). |
There was a problem hiding this comment.
I don't think this link will resolve in the NPM content: https://www.npmjs.com/package/@agoric/synthetic-chain
I had put it here so people consuming this package would have docs for it. That's not a priority anymore so I'm fine with you moving it and this breaking. just FYI
gibson042
force-pushed
the
gibson-2025-05-readme-improvements
branch
from
90780ac to
8ca38b0
Compare
No description provided.