Skip to content

docs: lead README with a recorded wiring-check demo#2

Merged
solomonneas merged 1 commit into
mainfrom
docs/readme-proof-recording
Jun 26, 2026
Merged

docs: lead README with a recorded wiring-check demo#2
solomonneas merged 1 commit into
mainfrom
docs/readme-proof-recording

Conversation

@solomonneas

Copy link
Copy Markdown
Collaborator

Adds the proof-first hero the adoption upgrade was missing.

What changed

  • Recorded terminal demo near the top of the README (docs/assets/agentnotify-wiring.svg): init scaffolds a config, doctor flags the unconfigured channels, then after the channel env is set doctor reports every channel ready, all without sending a notification. Reproducible from the committed .cast.
  • CHANGELOG note under Documentation.

Proof + safety

Generated by plating from real agent-notify output (built from this repo's cmd/agent-notify, not the stale host binary). Run in an isolated HOME; channel env uses placeholder =x values (no real secrets); doctor is presence-only and makes no network calls. content-guard pre-push passed; plating's leak scan is clean.

Add a plating-rendered terminal recording near the top of the README:
init scaffolds a config, doctor flags the unconfigured channels, then after
the channel env is set doctor reports every channel ready, all without
sending a notification. Reproducible from the committed .cast.
@solomonneas
solomonneas merged commit 93b6f8e into main Jun 26, 2026
@solomonneas
solomonneas deleted the docs/readme-proof-recording branch June 26, 2026 15:50
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