docs: restructure README per guidelines + abstract architecture diagram

[Miyamura80]

Summary

Applies the project's README style guide and makes the architecture documentation resistant to refactoring.

README (README.md)

Reordered to the guideline's invariant pitch → quickstart → depth → reference and layered on the style patterns:

• Centered masthead — bold tagline, •-separated nav bar, centered badge row. The version badge is now dynamic (reads Cargo.toml live via shields.io) instead of a hardcoded v0.0.1; added a repo-size badge.
• > [!WARNING] maturity callout — converted the old bold "Status:" line into the proper GitHub callout.
• Progressive disclosure — CLI Commands, Configuration, Files on disk, Architecture, and Development moved behind <details>, each opening with a one-line TLDR:. The top-level scan now fits ~one screen.
• Annotated config.toml with inline comments alongside the env-var table (self-documenting schema).
• Collapsible ASCII architecture diagram + a CLI-commands table (enumerable facts as tables).
• Credits section (real Cargo deps) and a zero-maintenance contrib.rocks contributors footer.

All commands/flags were verified against the source (-f/--follow, -n/--lines, server add --command/--arg/--working-dir/--display-name, uninstall --purge).

Architecture (ARCHITECTURE.md)

Replaced the source-file tree ("Workspace layout": main.rs, daemon.rs, tunnel.rs, …) with an abstract Components diagram keyed on responsibility (control surface, supervisor, tunnel transport, child supervision). The diagram now captures architectural essence that survives renames and refactors rather than enumerating files that move around.

Deliberately omitted

Guideline sections that would have been fabrication for this project: structured Exit Codes table (the binary returns anyhow::Result, exit 0/1 only), a self-updating leaderboard asset, and ✅/❌ Use Cases workflow branches (stdiod is set-up-once infra, not an iterative authoring loop). A 🤖 Agent Quickstart was skipped as well — stdiod is operated by developers, not driven by coding agents.

Note

This branch was based on a local main that is ahead of origin/main, so the diff also includes pre-existing release-workflow and dependency-bump commits (release.yml, Cargo.toml/Cargo.lock) that were already on the branch and are not part of this docs work. They will drop out once main catches up.

🤖 Generated with Claude Code

---

Generated by Claude Code

---

Summary by cubic

Restructured the README to follow the pitch → quickstart → depth → reference flow and embedded a branded, abstract architecture SVG. ARCHITECTURE.md is now role-based, MCP-agnostic, and links to JSON Schema–generated wire types; the diagram now uses a rounded, dark laptop device surface to clarify local vs remote.

• Docs
  • Centered masthead with tagline and inline nav; dynamic version badge (reads Cargo.toml) and repo-size badge.
  • Converted the maturity note to a [!WARNING] callout and moved details behind collapsible sections with TLDRs; added a concise CLI table, annotated config.toml, Files on disk, Architecture, Development, Credits, and a contrib.rocks footer.
  • Added docs/architecture.svg near the top, styled to the Edison Hackbox brand; shows a rounded, dark laptop device surface (local), the Edison backend gateway, an optional remote LLM API, and the real loop via one outbound WebSocket tunnel; kept the ASCII diagram as a fallback and dropped the redundant cloud boundary.
  • ARCHITECTURE.md: replaced the file-tree with a role-based overview (control surface, supervisor, tunnel transport, child supervision); called out MCP-agnostic framing and linked the JSON Schema source of truth (schema/tunnel-protocol.json) for generated wire types.

^{Written for commit ecfba66. Summary will update on new commits.}

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

[cubic-dev-ai]

No issues found across 2 files

_{Re-trigger cubic}