Skip to content

docs: overhaul README + sync architectural/flow to current state - #73

Merged
CodexManvik merged 1 commit into
masterfrom
docs/readme-overhaul
Sep 22, 2026
Merged

CodexManvik merged 1 commit into
masterfrom
docs/readme-overhaul

Conversation

@CodexManvik

Copy link
Copy Markdown
Owner

Summary

  • README rewritten from scratch — from a sprawling status-update wall to a clean, confident project document that leads with what the system is and what it can do
  • architectural.md — ADR-026 "default off" language updated; embedding selector is now on by default in compose
  • flow.md — status date updated to 2026-09-22; Kafka/Helm noted as shipped

README changes in detail

The old README was ~370 lines of rolling status updates, blockquote streams, and internal-team notes. The new README is structured for a first-time reader (or a presentation audience):

Section What it does
One-liner + tagline States the project in one sentence
Demo video placeholder Space for the launch video (comment shows the embed format)
What it does 4-row table: problem → what IntelliOps does
What's actually running Bullet list of what's real, not aspirational
Architecture diagram Same ASCII diagram, promoted to its own section
Design principles The 5 principles, as prose not buried in a blockquote
Tech stack table With opt-in/swap column
Quickstart Trimmed to actual commands; VITE_OPERATOR_NAME wired in
Meridian section 3-scenario verification table
Safety & compliance Every safeguard listed
What's been built All-✅ completeness table
Documentation map Clean table
Repo layout Updated to reflect all 8 services
Why this exists Moved to the bottom — context for those who want it

Test plan

  • README renders correctly on GitHub (check tables, code blocks, ASCII diagrams)
  • Demo video placeholder comment visible in raw view, not rendered
  • All doc links resolve (architectural.md, flow.md, docs/*.md)
  • Merge after fix/demo-polish (fix(demo): operator identity from env + enable embedding selector #72) so the RUNBOOK_SELECTOR_MODE note in architectural.md is consistent with compose

🤖 Generated with Claude Code

README rewritten from scratch:
- Opens with a one-line project statement + demo video placeholder
- "What it does" table (the four AIOps problems + what IntelliOps does about each)
- "What's actually running" section that lists the real stack components,
  not aspirational ones — Meridian, SSE, real k8s remediation all called out
- Architecture diagram kept, design principles promoted to first-class section
- Full tech-stack table with opt-in/swap column
- Quickstart trimmed to the actual commands; VITE_OPERATOR_NAME wired in
- Meridian section with the verified 3-scenario results table
- Safety & compliance section listing every safeguard
- "What's been built" completeness table (all ✅)
- Documentation map + repo layout

architectural.md:
- ADR-026 note updated: RUNBOOK_SELECTOR_MODE now defaults to "embedding"
  in compose (matches the fix/demo-polish change); opt-in language removed

flow.md:
- Status date updated 2026-08-18 → 2026-09-22
- "Kafka binding and Helm deploy" noted as shipped

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 22, 2026 16:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Sep 22, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: b60d54b1-6976-4ea9-8fba-e6dd9b44a31e


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

Comment @coderabbitai help to get the list of available commands.

@CodexManvik
CodexManvik merged commit 1ca3d3e into master Sep 22, 2026
6 checks passed
@CodexManvik
CodexManvik deleted the docs/readme-overhaul branch September 22, 2026 16:15
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.

2 participants