Repository navigation
docs: rewrite README for current project state - #5
Conversation
The README was significantly outdated — it listed guard, costs, and restore as "coming next" features when all three are fully implemented. It also missed the entire alerting overhaul (HMAC signing, severity levels, retry limits, resolution notifications, test/history commands). Rewritten in OSS style with complete command reference, alerting documentation, architecture diagram, FAQ, and full project structure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe README.md was comprehensively rewritten to restructure and expand documentation for the soroban-sentinel sentinel daemon. Changes include reformatted branding with a new Features section, expanded CLI command reference with detailed option tables, enhanced alerting specification with webhook and Slack details, improved daemon operation and configuration guides, and refreshed project structure and implementation documentation. ChangesDocumentation Restructuring and Expansion
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
docs: rewrite README for current project state
docs: rewrite README for current project state
The README was significantly outdated — it listed guard, costs, and restore as "coming next" features when all three are fully implemented. It also missed the entire alerting overhaul (HMAC signing, severity levels, retry limits, resolution notifications, test/history commands).
Rewritten in OSS style with complete command reference, alerting documentation, architecture diagram, FAQ, and full project structure.