docs: simplify README positioning, add use cases, drop ROADMAP#122
Merged
Conversation
Lead the README with a plain "like Playwright, but for terminal apps" analogy and a "What you'd use it for" section so non-developers grasp it in one read. Surface the read-only dashboard as a first-class capability, make the real PNG/WebM visual-proof edge explicit, and fix stale 0.2.x version text (now 0.3.0). Delete ROADMAP.md and remove its now-dangling links from the active docs (AGENTS.md, RELEASE.md, docs/, design/). Frozen history under design/archive/ and dogfood/ is left untouched. Change-Id: Iad61eed814e24ff75eb3e77e376f0a56eaceac62 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Thomas Kosiewski <tk@coder.com>
ThomasK33
force-pushed
the
docs/simplify-readme-drop-roadmap
branch
from
63c3dac to
90d369d
Compare
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.
Summary
Docs-only refresh of the repo front door. Sharpens the README's positioning, adds a concrete use-case section, documents the live dashboard, and retires
ROADMAP.mdalong with every cross-reference to it.README
tmux/screenup front.dashboard(libghostty-vt renderer, append-only event log as source of truth,list --jsonfor machine-readable listing).0.2.xto0.3.0/0.3.x.Drop ROADMAP.md
ROADMAP.mdand remove all references fromAGENTS.md,RELEASE.md,docs/CONTRIBUTING.md,docs/README.md,docs/RELEASE-PROCESS.md,design/ARCHITECTURE.md,design/README.md, anddesign/20260319_agent-tty-v1/03-rendering-and-artifacts.md. Deferred work is described inline where relevant instead of pointing at a separate roadmap doc.Test plan
ROADMAP.mdreferences.🤖 Generated with Claude Code