Skip to content

Docs fixes - #15

Merged
evanorti merged 3 commits into
mainfrom
docs-fixes
Aug 25, 2026
Merged

Docs fixes#15
evanorti merged 3 commits into
mainfrom
docs-fixes

Conversation

@evanorti

Copy link
Copy Markdown
Collaborator

No description provided.

@evanorti
evanorti merged commit aa07732 into main Aug 25, 2026
4 checks passed
@github-actions

Copy link
Copy Markdown

⚠️ Potential sync conflict detected

This PR modifies tutorial docs that are also modified in open sync PR(s) on cosmos/docs:

Overlapping files:

  • docs/05-run-and-test.md

These files are kept in sync between the two repos. Merging this PR before the sync PR is resolved may cause conflicts. Please coordinate with the sync PR author or wait until it is merged first.

@greptile-apps

greptile-apps Bot commented Aug 25, 2026

Copy link
Copy Markdown

Greptile Summary

This PR corrects and expands tutorial guidance for transaction output and governance-based counter parameter updates.

  • Documents the synchronous transaction broadcast response and transaction lookup command.
  • Replaces an unusable direct parameter-update example with a governance proposal workflow.
  • Records the tutorial verification work and resulting corrections in the changelog.

Confidence Score: 4/5

The transaction-query race should be corrected before merging so readers do not receive a transient “not found” result after following the new instructions.

The new tutorial text correctly identifies that synchronous broadcast returns before block inclusion but immediately recommends an index-backed transaction query without the wait used by the repository's own transaction flow.

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

Important Files Changed

Filename Overview
CHANGELOG.md Records extensive verification results and explains the two documentation corrections introduced by the PR.
docs/03-build-a-module.md Clarifies synchronous broadcast output but directs readers to query the transaction without waiting for block inclusion.
docs/05-run-and-test.md Replaces the invalid direct parameter-update command with a governance proposal and local shortened-voting-period workflow.

Comments Outside Diff (1)

  1. docs/03-build-a-module.md, line 743 (link)

    P1 Transaction query races inclusion

    When a reader runs exampled query tx <txhash> immediately after the synchronous broadcast acknowledgement, the transaction has not yet entered a block or the transaction index, causing the query to report that it was not found instead of showing the executed result.

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

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