Skip to content

Rewrite README as full onboarding guide - #31

Merged
yatesjalex merged 1 commit into
mainfrom
yatesclaude/elegant-jackson-46ee65
Apr 23, 2026
Merged

Rewrite README as full onboarding guide#31
yatesjalex merged 1 commit into
mainfrom
yatesclaude/elegant-jackson-46ee65

Conversation

@yatesjalex

Copy link
Copy Markdown
Owner

Summary

  • Rewrite the README from a light feature list into a full onboarding guide — any new engineer can clone, run, and exercise every v2 flow without external context.
  • Promote /earn/activity?scenario=mixed&admin=1 to the top of the file and add a six-step admin walkthrough for testing SSE (connect, multi-tab leader election, Last-Event-ID resume), partner webhooks (HMAC + idempotency), and the Investigation Agent (streaming, tool use, cached replay).
  • Expand structural reference: full tRPC procedure table, file-layout tree across app/, src/server/, src/features/, src/lib/, env var table, CI gate list, and per-area test coverage highlights.
  • Correct the Investigation Agent model to claude-haiku-4-5 (previous README + demo script claimed claude-sonnet-4-6; source in src/server/ai/system-prompt.ts says Haiku, with a matching comment explaining no extended thinking).

Test plan

  • Read the new admin flow section top-to-bottom and verify every file link resolves.
  • Follow the admin walkthrough against pnpm dev and confirm each step matches what actually happens in the UI (SSE pill, webhook morph, multi-tab sync, resume, agent drawer).
  • Confirm pnpm typecheck, pnpm test, pnpm build, pnpm e2e still pass (no code changed — docs only).

🤖 Generated with Claude Code

Expand the README so a new engineer can clone, run, and exercise every
v2 flow — SSE, leader election, Last-Event-ID resume, partner webhooks,
and the Investigation Agent — from the admin URL alone. Adds a dedicated
admin walkthrough, the full tRPC procedure table, a file-layout tree,
env-var reference, and corrects the agent model to claude-haiku-4-5.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Apr 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
super Ready Ready Preview, Comment Apr 23, 2026 4:56am

@yatesjalex
yatesjalex merged commit f06548e into main Apr 23, 2026
3 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