Skip to content

Commit e267c0f

Browse files
authored
docs: reorganize repository documentation (#17)
1 parent 5b47c76 commit e267c0f

58 files changed

Lines changed: 823 additions & 115 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

AGENTS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@ Session state is stored under `~/.agent-terminal` by default. In tests and autom
2929
- `src/renderer/ghosttyWeb/backend.ts` — reference renderer and Playwright browser harness.
3030
- `src/export/asciicast.ts` and `src/export/webm.ts` — recording export logic.
3131
- `src/util/assert.ts` — shared fail-fast assertion helpers.
32-
- `design/20260319_agent-terminal-v1.md` — architecture and product intent.
33-
- `dogfood/` — proof bundles plus scripts for reviewer-facing validation artifacts.
32+
- `design/ARCHITECTURE.md` — stable architecture and product intent overview.
33+
- `ROADMAP.md` and `RELEASE.md` — shipped scope vs deferred scope at the repo root.
34+
- `dogfood/README.md` and `dogfood/CATALOG.md` — proof-bundle navigation and reviewer-facing validation artifacts.
3435

3536
## Important directories
3637

@@ -43,7 +44,8 @@ Session state is stored under `~/.agent-terminal` by default. In tests and autom
4344
- `test/integration/` — CLI-level behavior against isolated temp homes.
4445
- `test/e2e/` — higher-level fixture-driven flows that assert rendered output and artifacts.
4546
- `test/fixtures/apps/` — tiny terminal apps used by e2e and dogfooding.
46-
- `design/` — architecture, roadmap, and dogfooding docs.
47+
- `design/` — architecture references and archived planning/status docs.
48+
- `docs/` — contributor and maintainer workflow docs.
4749

4850
## Architecture
4951

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ agent-terminal --home "$AGENT_HOME" snapshot "$SESSION_ID" --format text --json
3030
agent-terminal --home "$AGENT_HOME" destroy "$SESSION_ID" --json
3131
```
3232

33+
## Documentation map
34+
35+
- [`RELEASE.md`](./RELEASE.md) — the current `0.1.0` release contract.
36+
- [`ROADMAP.md`](./ROADMAP.md) — intentionally deferred work and post-release direction.
37+
- [`design/README.md`](./design/README.md) — architecture references plus archived week-by-week planning.
38+
- [`dogfood/CATALOG.md`](./dogfood/CATALOG.md) — curated proof bundles and recommended review paths.
39+
- [`docs/README.md`](./docs/README.md) — contributor and maintainer navigation.
40+
3341
## Feature highlights
3442

3543
- Full session lifecycle management: create, inspect, list, wait, destroy, and garbage-collect.
@@ -41,9 +49,8 @@ agent-terminal --home "$AGENT_HOME" destroy "$SESSION_ID" --json
4149
## 0.1.0 release focus
4250

4351
`agent-terminal` `0.1.0` is the first release aimed at reliable, isolated, reviewable TUI automation.
44-
Week 9 closes the release-readiness bar around the new `run` command, isolated-environment renderer reliability, and isolation-aware `doctor` diagnostics.
45-
For the explicit release contract, see [`RELEASE.md`](./RELEASE.md).
46-
Reviewer-facing proof bundles live under `dogfood/`, including `dogfood/20260326-week9-release-readiness/`, `dogfood/run-command/`, and `dogfood/20260325-week8-contract-locks/`.
52+
For the explicit shipping contract, see [`RELEASE.md`](./RELEASE.md). For intentionally deferred work, see [`ROADMAP.md`](./ROADMAP.md).
53+
Reviewer-facing proof bundles are curated in [`dogfood/CATALOG.md`](./dogfood/CATALOG.md), with current release-signoff evidence in `dogfood/20260326-week9-release-readiness/` and evergreen workflow coverage such as `dogfood/run-command/`.
4754

4855
## TUI Workflow
4956

@@ -214,15 +221,16 @@ npm run verify
214221
```
215222

216223
That runs formatting, linting, typechecking, unit/e2e tests, and the production build.
224+
For contributor workflow and release hygiene, see [`docs/CONTRIBUTING.md`](./docs/CONTRIBUTING.md) and [`docs/RELEASE-PROCESS.md`](./docs/RELEASE-PROCESS.md).
217225

218226
## Design docs
219227

220-
Design and implementation notes live under `design/`, especially `design/20260319_agent-terminal-v1/`.
221-
See `design/20260319_agent-terminal-v1/` for architecture, weekly plans, and status docs through Week 9, and see [`RELEASE.md`](./RELEASE.md) for the `0.1.0` contract.
228+
Design and implementation notes live under [`design/`](./design/README.md).
229+
Start with [`design/ARCHITECTURE.md`](./design/ARCHITECTURE.md) for the stable overview, use [`design/20260319_agent-terminal-v1/`](./design/20260319_agent-terminal-v1/) for the active reference set, and use [`design/archive/`](./design/archive/) for week-by-week project history.
222230

223231
## Repository notes
224232

225233
- CI uses `mise` for tool provisioning and quality-gate entrypoints.
226234
- Chromium is required locally for screenshot and replay export coverage.
227235
- Platform support tiers are documented in this README; see also the design docs for detailed status.
228-
- Dogfood proof bundles and validation notes live under `dogfood/` and `design/`.
236+
- Dogfood proof bundles and review guidance live under [`dogfood/README.md`](./dogfood/README.md) and [`dogfood/CATALOG.md`](./dogfood/CATALOG.md).

RELEASE.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
`agent-terminal` `0.1.0` is the first release that explicitly targets isolated, reviewable terminal automation for real TUI workflows.
44
The contract below is the bar for what maintainers should feel comfortable supporting at release time.
5-
If a workflow depends on behavior outside this document, it should be treated as future-scope or best-effort rather than a guaranteed `0.1.0` capability.
5+
If a workflow depends on behavior outside this document, treat it as future-scope or best-effort rather than a guaranteed `0.1.0` capability.
6+
For intentionally deferred work, see [`ROADMAP.md`](./ROADMAP.md). For reviewer-facing proof bundles, start with [`dogfood/CATALOG.md`](./dogfood/CATALOG.md).
67

78
## What 0.1.0 delivers
89

@@ -32,6 +33,6 @@ If a workflow depends on behavior outside this document, it should be treated as
3233

3334
## Validation
3435

35-
- Current release bar: 595 tests across 56 test files.
36-
- Reviewer-facing proof bundles live under `dogfood/`, including `dogfood/20260326-week9-release-readiness/`, `dogfood/run-command/`, and `dogfood/20260325-week8-contract-locks/`.
36+
- Current release bar: 602 tests across 56 test files.
37+
- Reviewer-facing proof bundles are cataloged in [`dogfood/CATALOG.md`](./dogfood/CATALOG.md), including `dogfood/20260326-week9-release-readiness/`, `dogfood/run-command/`, and `dogfood/20260325-week8-contract-locks/`.
3738
- Run `npm run verify` for the full validation bar.

ROADMAP.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# agent-terminal roadmap
2+
3+
`RELEASE.md` defines what `0.1.0` ships today. This roadmap tracks intentionally deferred work and post-release direction so the repository front door separates shipped scope from future scope.
4+
For historical week-by-week planning and status context, see [`design/archive/`](./design/archive/). For the stable design overview, see [`design/ARCHITECTURE.md`](./design/ARCHITECTURE.md).
5+
6+
## Near-term refinements
7+
8+
- Broader reviewer-oriented introspection in `inspect --json`, especially around live renderer/session state when that adds clear operational value.
9+
- Stronger proof-bundle conventions and automation so canonical `dogfood/` bundles stay easy to review and harder to let drift.
10+
- Continued hardening around renderer/bootstrap ergonomics in isolated environments.
11+
12+
## Renderer and platform expansion
13+
14+
- Native renderer adapters beyond the current `ghostty-web` reference backend.
15+
- Broader native-platform parity work, especially where Windows or native terminals diverge from the reference renderer.
16+
- Follow-on renderer hardening such as tighter CSP or sandbox assumptions if the backend model evolves.
17+
18+
## Input and automation expansion
19+
20+
- Mouse input support.
21+
- Richer semantic TUI automation beyond the current shell-oriented lifecycle, wait, snapshot, screenshot, and export flows.
22+
- Additional higher-level workflows only after they fit the event-log-as-truth model and do not undermine the stable CLI surface.
23+
24+
## System integration
25+
26+
- Remote or networked session control.
27+
- An MCP wrapper or other external control layers built on top of the CLI contract.
28+
29+
## Data-model redesigns
30+
31+
- Broader failure-taxonomy work beyond the current shipped termination/reporting categories.
32+
- Event-log redesign only if the current append-only model proves too limiting for replay or recovery needs.
33+
- Snapshot-schema expansion where the existing structured surface is not sufficient for review or automation use cases.
34+
35+
## Prioritization notes
36+
37+
1. Preserve the current release contract before widening scope.
38+
2. Prefer incremental additions that reuse the existing CLI, storage, replay, and artifact model.
39+
3. Archive historical planning/status detail instead of mixing it back into the roadmap.

WEEK2-GAPS.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

design/20260319_agent-terminal-v1/03-rendering-and-artifacts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The current renderer/export path is:
5858

5959
`inspect` now also exposes shipped artifact-health reporting derived from the artifact manifest plus on-disk files. That summary reports artifact totals, `byKind` counts, `missingCount`, an overall `health` value (`healthy`, `missing-artifacts`, `manifest-invalid`, `no-artifacts`, or `unknown`), and optional per-artifact `missing` details when files referenced by the manifest are absent on disk.
6060

61-
Remaining follow-on work is now mostly about design parity and broader future-scope renderer/runtime expansion rather than missing artifact classes. The repo already ships scrollback snapshots, optional per-cell snapshot data, bundled deterministic fonts, and replay timing modes. The main still-open design items are the fuller event-log and snapshot-schema redesigns plus later native/parity work tracked in [`../WEEK2-GAPS.md`](../WEEK2-GAPS.md).
61+
Remaining follow-on work is now mostly about design parity and broader future-scope renderer/runtime expansion rather than missing artifact classes. The repo already ships scrollback snapshots, optional per-cell snapshot data, bundled deterministic fonts, and replay timing modes. The main still-open design items are the fuller event-log and snapshot-schema redesigns plus later native/parity work tracked in [`../../ROADMAP.md`](../../ROADMAP.md).
6262

6363
## 4. Canonical replay model
6464

@@ -544,4 +544,4 @@ The remaining design-level follow-ons are now narrower:
544544
- whether to expand per-cell metadata beyond the currently shipped fields (for example `width`, `inverse`, `blink`, `dim`, or richer cursor metadata),
545545
- runtime renderer capability discovery beyond the current static backend list,
546546
- larger event-log and snapshot-schema redesign questions,
547-
- and later native renderer/parity work tracked in [`../WEEK2-GAPS.md`](../WEEK2-GAPS.md).
547+
- and later native renderer/parity work tracked in [`../../ROADMAP.md`](../../ROADMAP.md).

0 commit comments

Comments
 (0)