Skip to content

Reconcile README with current source tree - #84

Merged
glenjbarber merged 1 commit into
mainfrom
claude/relaxed-knuth-1frpkt
Oct 13, 2026
Merged

glenjbarber merged 1 commit into
mainfrom
claude/relaxed-knuth-1frpkt

Conversation

@glenjbarber

Copy link
Copy Markdown
Owner

Summary

  • Updates the implementation-status tables to reflect the packages that now exist (cmd/orcli, internal/config, internal/keychain, internal/mcp, internal/saved, internal/tools, internal/tui, and the various API client packages), and keeps internal/bootstrap/internal/complete listed as not yet written, since they genuinely are not.
  • Removes the stale "no cmd/orcli yet, so no binary" claim and the dangling DESIGN.md/AGENTS.md references (neither file exists in the repo).
  • Corrects the package dependency diagram to show cmd/orcli as the only package that imports both tui and tools, wiring them together at runtime rather than either importing the other.
  • Rewrites the "Rendering" section to describe tcell's actual, narrow role (terminal init, terminfo capability lookup, input decoding) rather than claiming raw syscall with no terminal library, while still noting that screen painting is direct raw writes to stdout, not tcell's own Draw/Show path. Notes that internal/tui's fully tview/tcell-rendered code path (startScreenMode) has no callers and is not reached at runtime.
  • Removes the stale "This is the one package that exists." line under "API client".

Fixes #30

Test plan

  • make test (all packages pass)
  • Manual read-through of the updated README against the current source tree

🤖 Generated with Claude Code

https://claude.ai/code/session_01Nxr4mW9rMNzn9kThjdJpZt


Generated by Claude Code

Updates the implementation-status tables to reflect the packages that
now exist (cmd/orcli, config, keychain, mcp, saved, tools, tui, and
the API client packages), removes the stale "no cmd/orcli binary"
claim and the dangling DESIGN.md/AGENTS.md references, corrects the
dependency diagram to show cmd/orcli as the sole package wiring tui
and tools together, and rewrites the Rendering section to describe
tcell's actual narrow role (terminal init, terminfo, input decoding)
versus the still-raw-stdout screen painting, noting that the
tview/tcell-rendered startScreenMode path has no callers.

Fixes #30

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nxr4mW9rMNzn9kThjdJpZt
@glenjbarber
glenjbarber marked this pull request as ready for review October 13, 2026 20:10
@glenjbarber
glenjbarber merged commit 4c73e53 into main Oct 13, 2026
1 check passed
@glenjbarber
glenjbarber deleted the claude/relaxed-knuth-1frpkt branch October 13, 2026 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README review: replace obsolete implementation status and renderer description

2 participants