docs(daemon): use obsigna CLI names in README and doctorcli comments#826
Merged
Conversation
…and doctorcli comment The daemon binary already emits `obsigna doctor` (doctor.go:132,164,689; CHANGELOG 0.24.0), but daemon/README.md and the doctorcli package comment still used the old `agent-receipts` CLI names. Migrate the README's read-interface sections, examples, and source map to the canonical `obsigna receipt <verb>` / `obsigna doctor` form (ADR-0030), drop the stale `--chain-id default` from examples, and fix the package comment. Left as-is: the literal `agent-receipts-doctor.roundtrip` emit identifier, the `did:agent-receipts-daemon:local` issuer, `$XDG_DATA_HOME/agent-receipts` paths, and example JSON data — none are the read CLI. Comment-only Go change; daemon build/vet and doctorcli tests pass.
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.
What
The daemon binary already emits
obsigna doctor(doctor.go:132,164,689; CHANGELOG 0.24.0), butdaemon/README.mdand a couple of source comments still used the oldagent-receiptsread-CLI names. Surfaced by the doc-e2e Raj/Go persona (#708 harness), which ran the published v0.23.0 binary and saw the mismatch.Changes
daemon/README.md: migrate the read-interface sections, command examples, and source map to the canonicalobsigna receipt <verb>/obsigna doctorform (ADR-0030); drop the stale--chain-id defaultfrom examples (no such chain post-feat(daemon): auto-advance chain ID on terminal tail; date-based default #735).doctorcli/doctor.go+tests_doctor_test.go: package/test comments now sayobsigna doctor.Left as-is (intentionally)
CHANGELOG.mdentries that mentionagent-receipts doctor— historical records (incl. the 0.24.0 entry that documents this very rename).agent-receipts-doctor.roundtripemit identifier,did:agent-receipts-daemon:localissuer,$XDG_DATA_HOME/agent-receiptspaths, and example JSON data — none are the read CLI.No functional code change (comments only).
go build/go vetanddoctorclitests pass locally.