docs(peat-cli): correct write-flag and wait-for-sync documentation#122
Merged
Conversation
`--wait-for-sync` was documented (QUICKSTART prose + create/update/delete clap help) as blocking until a peer acknowledged the write. It is a fixed-period approximation (POST_WRITE_SYNC_WAIT), not a delivery or durability guarantee. Align all four surfaces with that reality. Also: - README `update` synopsis was missing `--no-validate`, which the command accepts (flag parity with `create`). - QUICKSTART: lead with the mDNS two-process path (simplest peer), demote compose/peat-node to alternatives; retitle Step 3 to cover update + delete; document `query --limit` and `observe --mode` (incl. the latest-only-only caveat); add a "Beyond CRUD" section distinguishing arbitrary-JSON from schema-registered collections and pointing typed authoring at peat/peat-schema.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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
1 participant
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.
Summary
Documentation-accuracy pass on
peat-cli, prompted by a QUICKSTART review. No behavior changes — prose and clap--helptext only.Correctness
--wait-for-syncwas overstated as "blocks until at least one peer has acknowledged the write" in the QUICKSTART and in thecreate/update/delete--helptext. It is a fixed-period approximation (POST_WRITE_SYNC_WAIT,writes.rs), not a delivery/durability guarantee. All four surfaces now say so, matching the README's existing honest framing.updatesynopsis was missing--no-validate— the command accepts it (flag parity withcreate, confirmed inupdate.rs).QUICKSTART restructure (simplicity + completeness)
peat-node); demote compose /peat-nodeto clearly-marked alternatives.query --limitandobserve --mode(including the latest-only-only caveat — other modes warn and fall back).~5–10 min, path-dependent).New "Beyond CRUD — extending the schema" section
Addresses the missing on-ramp from operator usage to development:
writes.rs).peat/peat-schemacrate, gated by the ecosystem invariants.proto/sidecar.protoexpecting the CLI to pick it up (CLI = mesh node;sidecar.proto= co-located-app gRPC API).Verification
cargo fmt --check✅cargo clippy --workspace --all-targets -- -D warnings✅ (pre-commit hook)cargo test -p peat-cli --lib✅ 63 passedNote
No tracking issue exists for this docs fix. Happy to open one and link it if repo policy requires it for this PR.