Repository navigation
docs: rewrite the README to promote the project - #366
Merged
Merged
Conversation
Rewritten from scratch against the outline settled in planning: title and badges, the demo video, the two selling points, how it works, four screenshots, install, architecture, licence. Both Mermaid diagrams are drawn from the code rather than from the plan's sketch. The component diagram follows the two agent routes as they are: Claude Code through its own roster and two hooks, written to over the inbox socket each session already binds; Codex through the shared `codex app-server` this product starts and the user's terminals join, which is the same process the Live Call's realtime route rides. The sequence diagram follows `_session_stopped`: the reading goes to the roster, the Stop Notice goes to the Companion Channel as an Anchor, and the Call Keeper is woken to dial, briefing itself from the roster at the moment it acts. The four screenshots are captured from the app as it runs, in its dark appearance. The demo video's link is still pending: a `user-attachments` URL only exists once the file has been dragged into a GitHub comment box, so the video slot carries a marked placeholder with those instructions. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Rewrites
README.mdfrom scratch against the outline settled in planning: title and badges, the demo video, the two selling points, how it works, four screenshots, install, architecture, licence.The diagrams are read off the code
Both Mermaid diagrams are drawn from the source rather than from the plan's sketch.
The component diagram follows the two agent routes as they actually differ. Claude Code is read from its own roster and two hooks, and written to over the inbox socket every session already binds (
adapters/agent/claude/inbox.py,registration.py). Codex is read and written through the sharedcodex app-serverthis product starts and the user's own terminals join — the same process the Live Call's realtime route rides (adapters/call/realtime/adapter.py: "It owns no process. Thecodex app-serverthe realtime route rides is the engine's own, spawned and reaped by the Codex Agent adapter").The sequence diagram follows
core/bridge.py:_session_stopped: the reading goes to the roster, the Stop Notice goes to the Companion Channel as an Anchor, thenkeeper.wake()— the Keeper briefs itself from the roster at the moment it dials rather than from the stop's own reading (ADR 0017).Screenshots
Four, captured from the running app in its dark appearance: the Duty Lamp on a call, the Control Panel, Settings, and the Telegram conversation showing both reply routes.
They also fixed a real bug in the local capture helper: it took Telegram's shot last, after the Settings panel had been opened, and
capture()takes a region of the screen rather than a window — so the panel landed on top of Telegram every time. The window is now raised before its region is read.One thing still pending
The demo video's link. A
user-attachmentsURL only exists once the file has been dragged into a GitHub comment box, which is not something theghCLI can do. The video slot carries a marked placeholder with those instructions; filling it is one edit.🤖 Generated with Claude Code