docs: restructure README — screenshots, slim comparison#176
Conversation
…trix - Lead with the flagship Rust TUI cockpit screenshot; add the web UI and Telegram screenshots to their sections; move the architecture diagram into the Architecture section (it was the hero). - Replace the 20-row comparison matrix (which dominated the top of the README) with a tight positioning paragraph + a link to a new docs/COMPARISON.md that holds the full feature-by-feature matrix. - Fix an inaccurate Omnigent claim while relocating it: Omnigent does have cross-session recall (search_conversations + a long-term memory store), so the matrix now frames the difference as memory *shape* (workspace- scoped verbatim episodes vs conversation FTS), not memory presence; drop the unverifiable "open-sourced by Databricks" attribution. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🤖 Gemini code reviewThe PR successfully restructures the README by relocating the large comparison table to a separate document ( Findings: 🔴 0 · 🟠 0 · 🟡 0 · 🟢 0 Tokens spent · ⬆️ Input: 4,738 · ⬇️ Output: 86 · Σ Total: 7,778 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #176 +/- ##
=======================================
Coverage 84.90% 84.90%
=======================================
Files 106 106
Lines 18678 18678
=======================================
Hits 15858 15858
Misses 2820 2820
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
The README front page is now a scannable overview (699 → 257 lines): hero + why + compare + quick start + architecture, a condensed Features overview that links into the detail, the frontend screenshots, and short pointers for the rest. - New docs/FEATURES.md holds the full feature reference (terminal keybindings, slash commands, memory ranking, context-reduction layers, Telegram commands, production-resilience table). - New docs/CONFIGURATION.md holds permission scopes + every env var + the config.json schema + ~/.codeoid/.env. - Fixed relative links that move with the content (../src/…, cross-doc anchors) and re-pointed the README's hero/nav anchors accordingly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The README/COMPARISON still described codeoid as a single-harness (Claude Agent SDK only) tool and contrasted that with Omnigent's "breadth." That predates the provider registry: codeoid now ships six backends behind one SessionProvider interface — claude (default), openai, gemini, codex, pi, gemini-cli — selectable per session and forkable across backends. - Hero, Architecture, Features intro, and footer no longer say "Claude only"; add a Multiple-harnesses feature bullet and a new docs/FEATURES.md#harnesses section (backend table + how to pick/fork). - Reframe the Omnigent comparison from breadth-vs-depth to the real axis: both are multi-harness; Omnigent emphasizes breadth + OS-level isolation + credential brokering, codeoid emphasizes memory + per-agent identity + token economics. Fix the matrix rows (Multi-harness: ❌→✅; Multi-model routing: ❌ roadmap → ~ per-session choice, auto-routing roadmap). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
CLAUDE.md still described a session as "one Claude Agent SDK process" and listed the agent as Claude-only. Reflect the ProviderRegistry: sessions drive a pluggable provider backend (claude default; openai, gemini, codex, pi, gemini-cli), add the src/daemon/providers/ tree, and update the stack + session definition accordingly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Why
The README was 699 lines: a 20-row comparison matrix dominated the top, the product screenshots (already on yashdatta.dev) were missing, and the whole feature reference lived inline. This makes it a scannable overview that links out for depth — closer to how top OSS projects lead.
What changed
Slimmed the README 699 → 257 lines. Front page is now: hero → why → compare → quick start → architecture → condensed Features overview → interfaces (screenshots) → short pointers → CLI/dev. Detail moved to docs:
docs/FEATURES.md— full feature reference (terminal keybindings, slash commands, memory ranking, context-reduction layers, Telegram commands, production-resilience table).docs/CONFIGURATION.md— permission scopes + every env var +config.jsonschema +~/.codeoid/.env.docs/COMPARISON.md— the full feature-by-feature matrix (was inline).Screenshots (were missing):
Accuracy fix (fact-checked against the real
omnigentsource):search_conversations+ a long-term memory store. Reframed as memory shape (workspace-scoped verbatim episodes vs conversation FTS), not memory presence. Dropped the unverifiable "open-sourced by Databricks" line; bumped Omnigent's mid-turn-input cell to ✅.Verification
docs/were re-pointed (../src/…, cross-doc anchors); no dangling#terminal-client/#web-uihero anchors.🤖 Generated with Claude Code
Update: multi-harness accuracy pass
Caught while auditing: the README still called codeoid a single-harness (Claude-only) tool and contrasted that with Omnigent's breadth. That predates the provider registry — codeoid now ships six backends behind one
SessionProviderinterface (claudedefault,openai,gemini,codex,pi,gemini-cli), selectable per session and forkable across backends. Fixed the hero/architecture/features/footer, added adocs/FEATURES.md#harnessessection, and reframed the Omnigent comparison from breadth-vs-depth to memory/identity-vs-isolation (both are multi-harness). Matrix rows corrected: Multi-harness ❌→✅, Multi-model routing ❌ roadmap → ~.