Skip to content

v0.8.6 docs: tighten README + ARCHITECTURE for an external reader #378

@Hmbown

Description

@Hmbown

Pitch

The README explains features. It doesn't yet explain why this exists, how the architecture is laid out, and where someone should look first. An external reader (potential acquirer, contributor, or evaluator) should be able to understand the project's shape in ~10 minutes from the repo root.

Concrete deliverables

  1. README hero — one-paragraph intent statement above the install block. "DeepSeek-TUI is a terminal-native coding agent built around DeepSeek V4's 1M-token context and prefix cache. Single binary, no Node/Python runtime. Ships an MCP client, sandbox, and durable task queue out of the box."
  2. README "How it's wired" — 3-paragraph high-level architecture: dispatcher → TUI → engine → tools. Link to docs/ARCHITECTURE.md for the full walkthrough.
  3. docs/ARCHITECTURE.md refresh — already exists; one editing pass to remove stale references (e.g. swarm cleanup landed in v0.8.5).
  4. CONTRIBUTING.md — currently terse; add a "shape of a typical PR" section pointing at recent v0.8.5 followup: full SwarmOutcome cascade — drop event variant, UI handlers, FanoutCard parking decision #357/quality: panic safety for spawned async tasks — only 3/36 spawn sites guarded #346//logout followed by a new API key can keep using the old key #343 as exemplars.
  5. A 90-second asciinema — 5-frame recording embedded in the README hero. Picks a real session showing thinking + tool calls + apply_patch + result.

Acceptance

  • README intent paragraph + architecture summary live in the first screenful.
  • ARCHITECTURE.md is current as of v0.8.6 (no swarm references, current crate map).
  • CONTRIBUTING.md has a "shape of a PR" section.
  • asciinema recording committed under `docs/media/`, embedded in README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationv0.8.6Targeting v0.8.6

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions