docs: fix typos and stale references across docs and comments#1306
Open
redstartechno wants to merge 1 commit into
Open
docs: fix typos and stale references across docs and comments#1306redstartechno wants to merge 1 commit into
redstartechno wants to merge 1 commit into
Conversation
This was referenced Jun 4, 2026
Combine five separate docs PRs (gonka-ai#1297, gonka-ai#1299, gonka-ai#1300, gonka-ai#1301, gonka-ai#1302) into a single PR, per maintainer request. - README.md: fix markdown formatting glitches; update stale Go version, dead launch-script reference, and renamed directory in the layout tree - inference-chain/readme.md: "srcipts" -> "scripts" - dev_notes/build.md: "Duing" -> "During" - 16 codespell-found typos in comments, docs, and log/error strings across decentralized-api, inference-chain, and testermint Documentation, comment, and log-string changes only; no runtime behavior is affected.
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
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.
What problem does this solve?
This PR combines five small, previously-separate documentation PRs (#1297, #1299, #1300, #1301, #1302) into a single PR, as requested by the maintainer. Together they fix:
README.md.README.md: an outdated Go version, a dead launch-script reference, and a renamed directory in the repository-layout tree.srcipts->scriptstypo ininference-chain/readme.md.Duing->Duringtypo indev_notes/build.md.codespell) in comments, docs, and log/error strings acrossdecentralized-api,inference-chain, andtestermint.How do you know this is a real problem?
Each change was verified against the current repository contents:
README.md:42): prerequisites saidGo 1.22.8, but bothinference-chain/go.modanddecentralized-api/go.moddeclarego 1.24.2— 1.22.8 cannot build the modules.README.md:66):launch-local-test-chain-w-reset.shdoes not exist anywhere in the tree (git grep). The real script islocal-test-net/launch.sh, whose header describes "1 genesis (seed) + 2 full nodes" (the README's "3 participants") and which doesrm -rf prod-local(the "-w-reset" behavior).README.md:100):/prepare-localdoes not exist; the real directory islocal-test-net, which matches the description on that line.srcipts(inference-chain/readme.md:19):inference-chain/scripts/init-local.shexists;srcipts/does not.codespelland each confirmed by reading the surrounding context (identifiers and domain terms thatcodespellflagged were left untouched).How does this solve the problem?
Each stale reference is updated to the correct, currently-existing target, and each typo is corrected in place. No code logic is changed — only documentation, comments, and human-readable log/error message strings.
What risks does this introduce? How can we mitigate them?
Minimal. The changes are limited to documentation, source-code comments, and log/error string literals; no control flow, types, or APIs change. The log/error string edits are pure spelling corrections within existing messages. Generated files (
*.pb.go,*.pulsar.go) and governance/genesis artifacts were intentionally not touched.How do you know this PR fixes the problem?
Documentation/comment/log-string change only, with no runtime behavior change. Rendered Markdown was visually checked (link and code-span syntax intact). Re-running
codespellafter the edits reports none of the corrected items remaining.Which components are affected?
README.md,dev_notes/build.mddecentralized-api(one comment, one Markdown doc)inference-chain(readme + comments and log/error strings)testermint(README, MCP guide docs, Kotlin log/error strings)Testing & evidence
No code paths changed; unit/integration tests are not applicable. Evidence is the repository checks above (
git grep/ls/go.mod) proving each old reference was wrong and each new reference exists, plus a cleancodespellre-run. Diffstat: 19 files, 23 insertions(+), 23 deletions(-) — every file a one- to five-line spelling/reference correction.Supersedes #1297, #1299, #1300, #1301, #1302.