Skip to content

update docs - #14

Merged
evanorti merged 1 commit into
mainfrom
docs-fixes
Aug 25, 2026
Merged

update docs#14
evanorti merged 1 commit into
mainfrom
docs-fixes

Conversation

@evanorti

Copy link
Copy Markdown
Collaborator

small updates to docs

@evanorti
evanorti merged commit 7ce7264 into main Aug 25, 2026
4 checks passed
@greptile-apps

greptile-apps Bot commented Aug 25, 2026

Copy link
Copy Markdown

Greptile Summary

The PR records an extensive tutorial verification pass and updates transaction and governance instructions based on live-chain testing.

  • Expands the synchronous transaction broadcast example and explains its pre-inclusion fields.
  • Replaces an unusable direct parameter-update command with a governance proposal workflow.
  • Documents how to shorten the local voting period without having make start discard the genesis edit.

Confidence Score: 4/5

The PR appears safe to merge, with one non-blocking tutorial timing issue that can make an immediate transaction lookup fail.

The governance documentation aligns with the module authority and local-chain setup, while the transaction tutorial should tell readers to wait or retry because its new query is issued before block inclusion is guaranteed.

Files Needing Attention: docs/03-build-a-module.md

Important Files Changed

Filename Overview
CHANGELOG.md Adds a detailed account of tutorial verification, resulting corrections, intentionally deferred issues, and remaining validation gaps.
docs/03-build-a-module.md Correctly distinguishes broadcast acknowledgement from execution, but the new transaction lookup can race block inclusion without wait or retry guidance.
docs/05-run-and-test.md Replaces the invalid direct parameter update with a detailed governance-based workflow consistent with the counter module's authority model.

Reviews (1): Last reviewed commit: "update" | Re-trigger Greptile

Comment thread docs/03-build-a-module.md
transaction by its hash:

```bash
exampled query tx <txhash>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Transaction lookup races inclusion

The acknowledgement arrives before block inclusion, so running exampled query tx <txhash> immediately can return “transaction not found” for a successful transaction. Add guidance to wait for the next block or retry the query so readers do not misdiagnose the broadcast as a failure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant