docs(readme): rewrite to match actual shipped features

[diskhacker]

Summary

Rewrite the public README to match the features that actually ship on main today. Pulled from the Sprint 1.5 deep audit of sigops@main.

Removed / moved to Roadmap (no code on main):

• FlowBuilder visual editor
• Bidirectional adapters for PagerDuty / Datadog / Grafana
• WebSocket agent gateway (agents use HTTP polling)
• Rate limiting on ingest
• OpenTelemetry / Prometheus metrics export
• Email signal polling
• Cloud section entries without code: SSO (SAML/OIDC), audit-log export to S3/SIEM, advanced RBAC with custom roles, multi-region deployment

Kept (verified in code):

• Signal ingestion (webhook + Prometheus + dedup)
• Signal rules engine (pattern/severity/regex/JSONPath)
• SEL language (parser + evaluator + tests)
• Workflows (CRUD + versioning + schedules)
• Executions + execution steps (state machine, retries, risk scoring)
• Agents (HTTP heartbeat polling + token rotation)
• 5 built-in tools (restart/http/notify_slack/wait/condition)
• Stats / dashboard API
• Auth (JWT HS256 + UAP registration)
• UI dashboard (10 pages)
• Docker (multi-stage server + UI Dockerfiles)

Added:

• ## Roadmap section listing the unshipped items above
• ## SigOps CLI section
• ## SigOps Cloud section limited to features with code in sigops-cloud (AI Advisor, Knowledge Engine, On-Call, War Room, Postmortem, Status Page, SLA Tracker, Marketplace)

Test plan

• Audit of shipped features against main source tree
• All removed claims mapped to Roadmap or Cloud
• Reviewer spot-checks that every bullet in "Core Features" maps to a module directory

https://claude.ai/code/session_01VZPc4xQECHmaTddwaq6zf2

Summary by CodeRabbit

Release Notes

• Documentation
  • Substantially rewrote README with refined product description and explicit signal-to-execution workflow framing
  • Reorganized and expanded sections on core features, architecture, and agent execution mechanics
  • Added comprehensive SigOps CLI and Cloud documentation sections
  • Refreshed configuration reference table, available scripts listing, and license attribution

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3987b8b4-eb1d-4b16-93bf-446fabd63f29

📥 Commits

Reviewing files that changed from the base of the PR and between d7d9dc4 and d7c66f5.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README was comprehensively restructured, reframing the project from "SigOps" to "SigOps — Infrastructure Execution OS" with an explicit signal→rules→workflow→agent→verification model. Multiple sections were reorganized, removed, or added, including streamlined core features, updated configuration tables, new CLI and Cloud sections, and consolidated architecture overview.

Changes

Cohort / File(s)

Summary

README Restructure README.md

Comprehensive rewrite of project description and organization. Replaced opening framing, removed "Quick Reference" and "What This Product Does" sections, added "What SigOps Does" and reformatted "Core Features" with signal/execution state-machine lifecycle details. Condensed architecture section, streamlined "Getting Started" into "Requirements" and "Quick Start", replaced environment variables section with configuration table, added "SigOps CLI" and "SigOps Cloud" sections, removed "Shared Packages" and "Development Protocols", updated scripts entries, and changed license attribution to "MIT — ClusterAssets Innovation Pvt. Ltd."

Estimated Code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

• PR#7: Modifies the same README.md file, converging on replacing authentication provider descriptions and reshaping the SigOps Cloud section presentation.

Poem

🐰 Hop, hop! The docs now shine so bright,
From murky depths to clarity's light,
Signals flow and rules take flight,
CLI and Cloud come into sight,
A README reborn, perfectly right! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-honesty

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}