Skip to content

Commit aa07732

Browse files
authored
Docs fixes (#15)
1 parent 7ce7264 commit aa07732

2 files changed

Lines changed: 4 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Corrections made to this pass's own first draft, both caught by testing claims i
2626
- The `05` gov section initially told readers to lower `voting_period` in `~/.exampleapp/config/genesis.json` before running `make start`. That does not work: `scripts/local_node.sh` line 7 deletes the entire home directory on every run, so the edit is destroyed. Replaced with the verified sequence (`make start` once, stop, edit genesis, `exampled comet unsafe-reset-all`, then `exampled start` directly). Confirmed end to end: proposal reached `PROPOSAL_STATUS_PASSED` and `query counter params` returned the new `add_cost: 200` / `max_add_value: 50`.
2727
- The same section claimed `MsgUpdateParams` can be reached by choosing `other` in `draft-proposal` and searching by name. Only the verifiable part is now stated: the top-level list contains just `text`, `community-pool-spend`, `software-upgrade`, `cancel-software-upgrade`, and `other`, and `other` opens a scroll-only list of type URLs that typing does not filter. Whether the counter message appears in that list was not confirmed, so the doc no longer asserts it and points at hand-written JSON instead.
2828

29+
Third correction, from Greptile's review on cosmos/docs#342: the genesis recipe told readers to lower only `voting_period`. The SDK requires `expedited_voting_period` to be strictly less than `voting_period` (`x/gov/types/v1/params.go:189`), and the default expedited period is 24 hours, so following the doc left the two inverted. The original verification missed it because the test run set both values while the doc only mentioned one. Greptile's stated mechanism was wrong: gov `ValidateGenesis` never calls `Params.ValidateBasic`, so the chain does start, confirmed by running it with `voting_period=20s` and `expedited_voting_period=24h` and watching it commit blocks normally. The suggested fix was right for a different reason, and the doc now changes both periods and explains why.
30+
2931
Still unverified after this pass: the prose claims (not code) in `04-counter-walkthrough.md`, and how the new `<Note>` and JSON blocks render on the live Mintlify site.
3032

3133
Known issues found and deliberately left alone in this pass: the doc's Go blocks use 4-space indentation, so all seven files a reader creates fail `gofmt -l` (`make lint` passes anyway, 0 issues, since gofmt is not in the golangci config); the seven `app.go` wiring blocks are flush-left and paste misaligned into indented context, and each includes its own marker comment as line 1, so a select-all paste duplicates the marker; `NewKeeper` takes a `cdc codec.Codec` the minimal module never uses, kept for signature parity with `main`; Step 12 gives no guidance to wait for the first block before submitting; `make proto-image-build` cold-builds Docker layers for several minutes with no warning that this is expected.

docs/05-run-and-test.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,8 +173,9 @@ home directory on every run. Let `make start` create the chain first, then stop
173173
# 1. Let make start create ~/.exampleapp, then stop it with Ctrl+C
174174
make start
175175

176-
# 2. Lower the voting period in the generated genesis
176+
# 2. Lower both governance voting periods in the generated genesis.
177177
# app_state.gov.params.voting_period, for example "20s"
178+
# app_state.gov.params.expedited_voting_period must stay strictly shorter, for example "10s"
178179
vi ~/.exampleapp/config/genesis.json
179180

180181
# 3. Wipe block history so the edited genesis is re-read, keeping keys and config

0 commit comments

Comments
 (0)