Rewrite README as coherent product doc#8
Merged
Conversation
Drops the iterative phase-by-phase framing (relevant during the refactor, confusing now that everything's merged) and replaces it with Features → Architecture → Quick start → Per-service runbook → Deploy → Configuration → Project layout. Adds an ASCII architecture diagram and a dedicated section per microservice with run commands; fixes the layout tree which was missing services/, deploy/, core/events, core/threat, core/observability, and .github/workflows. https://claude.ai/code/session_01THsbGHdqjcvJeWUwrzZtp8
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
2 participants
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.
Context
The README accreted phase-by-phase during the six-phase refactor; now that everything's merged the phase-numbered framing is confusing and the layout tree was missing half of what shipped (
services/,deploy/,core/events,core/threat,core/observability,.github/workflows).What changed
Single coherent doc structured as:
docker compose up+ a local-dev path withSCOPILOT_REDIS__URL=memory://.api,worker,threat_daemon,webex_bot,mcp_server,cli,app.py) with the exact run command.SCOPILOT_*env-var groups + pointer to.env.example.pytestinvocation + the "hermetic, no live API calls" note.No code touched — README only.
Generated by Claude Code