Correct marketplace install and publishing documentation - #25
Merged
Conversation
- add refuses pinned ids (termcade add author/slug@x.y.z); docs showed it as the way to install a version. The CLI rejects it outright. - Packages download through the registry, digest-verified against what the registry recorded at publish time; docs said clients fetch straight from GitHub. - Publishing requires an already-claimed handle (signup username or org membership); docs said the first publish claims the namespace. - Dev loop puts a local build on your menu with dev install, not add — matching the CLI's own guidance and docs/sdk.md. Refs aviorstudio/termcade-be#44
Member
Author
Review 1No findings. Residual test risk: Reviewed only the specified pinned one-commit diff (2 modified documentation files), using the head CLI/client code and backend route/service tests as controls. CI is reported successful; no commands or tests were run in this read-only review. Redaction: none. Verdict: APPROVE |
Member
Author
Review 1 replyNo findings require changes. The residual risk is accepted: this is a documentation-only diff, the reviewer checked the modified claims against the current CLI/client and backend route/service controls, and the terminal head CI completed successfully. No additional gate is warranted for this layer. Disposition: Review 1 is approving. |
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.
Refs aviorstudio/termcade-be#44
Documentation-only corrections of verified drift — no behavior changes.
What was wrong, and the proof
termcade add you/mygame@1.0.0in docs/packaging.md): the current CLI rejects it —versions cannot be pinned(cli.go, proven by running the built binary: exit 1). Docs now describe unpinned newest-compatible resolution (ABI sent with resolve; registry picks the newest release the binary can run — internal/registry/client.go Resolve, termcade-be handleResolve).add"downloads it straight from GitHub". Current client downloads from/v1/games/:author/:slug/downloadthrough the registry and refuses any package whose sha256 does not match the registry-attested digest (internal/registry/client.go Download; termcade-be handleDownload: "clients do not fetch from GitHub themselves"). Corrected.termcade addputs your local build on the menu: control comparison against README's own command table and docs/sdk.md (termcade dev install build/mygame.tcade) plus the CLI's rejection of non-marketplace ids. Corrected todev install.Validation
termcade helpand the command implementations (signup, add, dev install, whoami, username, org new, sync, keys new, list, remove, publish).gofmt -l .,go vet ./... ./sdk/...,go test -race -count=1 ./... ./sdk/...,GOWORK=off go build/vet, cross-compile of all five release targets.One-layer stack via gh-stack. No production CD surface for this docs-only change.