Skip to content

Improve README demo proof - #150

Merged
prashar32 merged 1 commit into
mainfrom
readme-demo-proof
Jun 20, 2026
Merged

Improve README demo proof#150
prashar32 merged 1 commit into
mainfrom
readme-demo-proof

Conversation

@prashar32

Copy link
Copy Markdown
Owner

Summary

  • Add a See it work first section near the top of the README with the no-key Docker demo and expected HTTP 402 output.
  • Add a crash-resume terminal recording and rendered GIF for examples/kill-9-resume.
  • Add a Pick a demo table so visitors can quickly choose the right example.
  • Remove the older buried demo paragraphs after the SDK quickstart to reduce README friction.

Why

The promotion flow needs the repository landing page to convert faster. New visitors should be able to see the runaway-agent proof, the crash-resume proof, and the right demo path without reading the whole README first.

Validation

  • env GOCACHE=/private/tmp/riskkernel-gocache go test ./internal/governor ./internal/runs ./internal/storage
  • git diff --check
  • Rendered and visually checked examples/kill-9-resume/resume.gif from the existing demo script.

@prashar32
prashar32 merged commit 2231ce3 into main Jun 20, 2026
4 of 5 checks passed
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