Skip to content

Commit f3169fb

Browse files
committed
docs(tank): add concept images to README and docs site
Add WIP notices to README and docs index. Add all 9 concept mockup images (idle, overlay, tool-exec, multi-pane, multi-agent, command palette, services, services-logs, detach/reattach). Create dedicated concepts.md page. Add GitHub Pages deployment workflow.
1 parent e5ce815 commit f3169fb

17 files changed

Lines changed: 1321 additions & 12 deletions

.github/workflows/docs.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Deploy docs
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- 'docs-site/**'
8+
- '.github/workflows/docs.yml'
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: true
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- uses: actions/checkout@v4
25+
- uses: actions/setup-python@v5
26+
with:
27+
python-version: '3.12'
28+
- run: pip install mkdocs-material
29+
- run: mkdocs build -f docs-site/mkdocs.yml -d ../site
30+
- uses: actions/upload-pages-artifact@v3
31+
with:
32+
path: site
33+
34+
deploy:
35+
needs: build
36+
runs-on: ubuntu-latest
37+
environment:
38+
name: github-pages
39+
url: ${{ steps.deployment.outputs.page_url }}
40+
steps:
41+
- id: deployment
42+
uses: actions/deploy-pages@v4

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,61 @@
11
# Tank
22

3+
> **Work in progress** — Tank is in early development. The protocol and
4+
> architecture are being designed; the Haskell implementation covers core CRDT
5+
> types, a VT100 emulator, standalone terminal mode, and a daemon skeleton.
6+
> APIs, commands, and interfaces will change.
7+
38
A protocol-centric workspace system with terminal multiplexing, per-pane
49
coding agents, and seamless session migration.
510

611
Named after Tank from The Matrix — the operator who loads programs, monitors
712
the crew, and runs the console.
813

14+
## Concept
15+
16+
<!-- concept images generated by docs-site/docs/assets/concepts/render-concepts.py -->
17+
18+
### Idle terminal
19+
20+
![Idle terminal](docs-site/docs/assets/concepts/01-idle.png)
21+
22+
### Per-pane coding agent (operator)
23+
24+
![Agent overlay](docs-site/docs/assets/concepts/02-overlay.png)
25+
26+
The operator reads files, executes commands, and writes fixes — all inside the
27+
overlay:
28+
29+
![Agent tool execution](docs-site/docs/assets/concepts/03-tool-exec.png)
30+
31+
### Multi-pane layout
32+
33+
![Multi-pane split](docs-site/docs/assets/concepts/04-multi-pane.png)
34+
35+
Each pane gets its own independent operator:
36+
37+
![Multi-pane agents](docs-site/docs/assets/concepts/05-multi-agent.png)
38+
39+
### Command palette
40+
41+
![Command palette](docs-site/docs/assets/concepts/06-windows.png)
42+
43+
### Per-project services
44+
45+
Manage project daemons via Procfile:
46+
47+
![Services overlay](docs-site/docs/assets/concepts/07-services.png)
48+
49+
Live daemon logs with tree view:
50+
51+
![Services logs](docs-site/docs/assets/concepts/08-services-logs.png)
52+
53+
### Session persistence
54+
55+
Detach and reattach — sessions survive disconnects:
56+
57+
![Detach and reattach](docs-site/docs/assets/concepts/09-detach.png)
58+
959
## Features (MVP)
1060

1161
- Terminal multiplexer with pane splits and sessions
@@ -60,7 +110,11 @@ devshell managers) are **plugs** that communicate via a Cap'n Proto binary
60110
protocol. State is synchronized using CRDTs with an epoch-tagged LWW grid and
61111
spatial jitter buffer for terminal screen sync.
62112

63-
See [Protocol Design](docs-site/docs/protocol.md) and [Architecture](docs-site/docs/architecture.md) for details.
113+
See the [documentation site](docs-site/docs/index.md) for details:
114+
115+
- [Architecture](docs-site/docs/architecture.md)
116+
- [Protocol Design](docs-site/docs/protocol.md)
117+
- [Terminal Screen Sync](docs-site/docs/screen-sync.md)
64118

65119
## Origin
66120

41.8 KB
Loading
43 KB
Loading
36.8 KB
Loading
62.6 KB
Loading
55 KB
Loading
59.3 KB
Loading
66 KB
Loading
88.4 KB
Loading

0 commit comments

Comments
 (0)