Repository navigation
docs: overhaul README + sync architectural/flow to current state - #73
Merged
Merged
Conversation
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>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
architectural.md— ADR-026 "default off" language updated; embedding selector is now on by default in composeflow.md— status date updated to 2026-09-22; Kafka/Helm noted as shippedREADME 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):
VITE_OPERATOR_NAMEwired inTest plan
fix/demo-polish(fix(demo): operator identity from env + enable embedding selector #72) so theRUNBOOK_SELECTOR_MODEnote in architectural.md is consistent with compose🤖 Generated with Claude Code