Skip to content

docs: say "confirmation" instead of "attestation" in update-check prose - #131

Merged
bompus merged 1 commit into
mainfrom
docs/plain-wording-attestation
Oct 11, 2026
Merged

bompus merged 1 commit into
mainfrom
docs/plain-wording-attestation

Conversation

@bompus

@bompus bompus commented Oct 11, 2026 •

Copy link
Copy Markdown
Owner

"Attestation" is jargon for what the update check records: the caller's own report that it loaded a revision. This changes the words in the help text, the server instructions, docs/updates.md and the README to "confirmation" / "loaded-revision confirmations", and says what each means ("a confirmation by the caller that it loaded the revision, not independent proof of provider cache replacement").

  • Prose only. The attested value of status and evidence in swarmail updates --session --json, and every flag and field name, are unchanged. docs/updates.md now says that a confirmed target shows status: "attested", so readers of the JSON can connect the two.
  • No agent behavior changes: the server instructions only point at swarmail updates --help with the new word.
  • Not touched: the 0.5.2-era changelog entry that already used "attestations" (history), code comments in src/updates.ts and test names.

Checks: bun run check passes. bun test: 1215 pass, 1 timed out at 5 s under load (test/build.test.js, "the committed profile builds a binary that runs"); that file passes alone (4 pass).


Summary by cubic

Replaces "attestation" with "confirmation" in update-check prose so the wording reflects what the check records: the caller's own report that it loaded a revision, not independent proof of provider cache replacement.

  • Updates the help text, server instructions, docs/updates.md, README, and the unreleased changelog section; the attested status value in swarmail updates --session --json and all flag and field names are unchanged.
  • docs/updates.md now notes that a confirmed target shows status: "attested" so JSON readers can connect the two.
  • No behavior changes; the older "attestation" changelog entry, code comments, and test names are left untouched.

Written for commit d972854. Summary will update on new commits.

View guided diff Turn on auto-fix

Summary by CodeRabbit

  • Documentation
    • Clarified that “confirmation” means the caller confirms an update target’s revision was loaded; it does not prove the provider’s cache was replaced.
    • Updated command help, settings descriptions, and update guidance to use consistent confirmation terminology. The attested JSON status remains unchanged.

@coderabbitai

coderabbitai Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c1723931-501b-4cf1-b19b-67eac2a378ee

📥 Commits

Reviewing files that changed from the base of the PR and between ff322be and d972854.


📒 Files selected for processing (5)
  • CHANGELOG.md
  • README.md
  • docs/updates.md
  • src/cli.ts
  • src/guidance.ts

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The updates command help, guidance, README, updates documentation, and changelog now describe loaded-revision records as caller confirmations. The JSON attested status remains unchanged.

Changes

Update confirmations

Layer / File(s) Summary
Confirmation terminology and semantics
src/cli.ts, src/guidance.ts, README.md, docs/updates.md, CHANGELOG.md
Help text and documentation use “confirmation” for caller-reported loaded revisions. The changelog clarifies that confirmation is not proof of provider cache replacement. The JSON attested status remains unchanged.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to d9728

This change clarifies that the recorded confirmation is the caller’s report, not proof of provider cache replacement; update behavior and the JSON status remain unchanged. No actionable merge risk is evident.

Pre-merge checks | Passed 6
✅ Passed checks (6 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main documentation change: replacing “attestation” with “confirmation” in update-check prose.
Description check Passed The description explains what changed and why, documents unchanged status values and behavior, reports test results, and addresses the required checklist items. The checklist boxes are not marked, but…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Suppressions Explained Passed The pull request changes only prose in CHANGELOG.md, README.md, docs/updates.md, src/cli.ts, and src/guidance.ts. No added lint, type-check, formatter, or ignore directive appears, and no configuratio…
Interface Changes Documented Passed The pull request changes only prose in CHANGELOG.md, README.md, docs/updates.md, src/cli.ts, and src/guidance.ts. The diff does not add, remove, or rename an MCP tool, argument, swarmail c…

✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR



🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

View guided diff | Turn on auto-fix | Re-trigger cubic

The help text, server instructions, docs/updates.md and README now call the
caller's own report that it loaded a revision a "confirmation". The
`attested` status value in `updates --session --json` is unchanged.
@bompus
bompus force-pushed the docs/plain-wording-attestation branch from 8092df9 to d972854 Compare October 11, 2026 06:22
@bompus
bompus merged commit a07bbfe into main Oct 11, 2026
4 checks passed
@bompus
bompus deleted the docs/plain-wording-attestation branch October 11, 2026 06:34
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