docs: add "live review surface" recipe (detached server + active watch loop + markdown renderer)#15
Open
samgob wants to merge 1 commit into
Open
Conversation
…renderer) Adds a step-by-step recipe that covers the two gaps the README surfaces but leaves as exercises: the parent-death watchdog footgun when launching the server from a Bash call, and the persistent inbox watch loop needed to keep Claude monitoring across multiple comment rounds. Also includes a markdown→HTML renderer and an optional visual change-bar overlay, all contributed under the same MIT license. Co-Authored-By: Claude Opus 4.8 <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.
What this adds
A new recipe (
docs/recipes/live-review-surface.md) with four companion example files (examples/live-review-surface/), covering the two gaps the README already surfaces but leaves as exercises:detach_server.pyuses a Unix double-fork so the server's PPID is already 1 before the watchdog first fires — it disables itself at startup and the server survives across comment rounds indefinitely.Monitor(persistent=true, ...)call that wakes Claude on every inbox append, plus a graceful degradation note for sessions whereMonitorisn't available.Also included:
render.py— a minimalpython-markdown-based renderer that converts markdown → GitHub-ish HTML before injection, with cross-page nav and an index builder.overlay.css/overlay.js— optional cosmetic layer that adds numbered left-gutter bars and a floating "Changes (N)" chip when Claude marks edits with[data-cf-change]attributes. Zero dependency onmake-pages-interactiveinternals.Scope
Purely additive — no changes to any existing file. The four example scripts are contributed under the same MIT license as this repository (noted in each file's docstring and in the recipe's attribution section).
Test
Tested end-to-end on macOS (darwin) with Python 3.11, Claude Code ≥ 1.x. The detached-server pattern verified by checking
ps -o ppid= -p $(lsof -ti:5050)returns 1 after launch.🤖 Generated with Claude Code