Skip to content

Commit fde8707

Browse files
committed
Compressed for calm, boring, operator-first tone. Changes mapped to your list:
1. Opening — say each thing once Single screen: workflow bullets → anchor → why (chat vs JoyZoning) → what it is not → audience → two arrow links. No repeated blockquotes, no second “not a second IDE” line, no diet-hermes in the hero. 2. JSDP — advanced, at the bottom New section “Advanced — multi-role delivery (optional)” after Stuck. Removed from the four-step table and Phase 3 paths. 3. Less manifesto vocabulary Dropped cognition, convergence, philosophy links in the main path, lease/orchestration in user-facing tables. philosophy.md only linked under Advanced. 4. Added “why” One short paragraph: most agents stop at chat; JoyZoning adds tracking, repo execution, verify, audit, controlled merge. 5. Plain language “Task activity” instead of execution viewport “Ready for your review” instead of lease jargon “One active task run per card” instead of lease “Step” instead of “Phase” in headings (lighter weight) Removed extra mermaid diagrams in the main path 6. Workflow tool framing Shorter sections, tables only where they help, habits as one line, contributor/docs at the end. Kept: “Trust Workspace, not chat, for sign-off” in Step 2. Kept: “Chat plans. Workspace is truth.” once at the top.
1 parent a20e582 commit fde8707

1 file changed

Lines changed: 73 additions & 141 deletions

File tree

README.md

Lines changed: 73 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
44
[![.NET 8](https://img.shields.io/badge/.NET-8.0-512BD4)](global.json)
55

6-
> ### Supervise AI coding on your machine.
6+
## Supervise AI coding on your machine.
77

88
JoyZoning is a local cockpit for agent work:
99

@@ -13,203 +13,135 @@ JoyZoning is a local cockpit for agent work:
1313
- Verify with tests and builds
1414
- Merge only when you approve
1515

16-
> **What it is not**
17-
>
18-
> - Not a second IDE
19-
> - Not an autonomous auto-merge bot
20-
> - Not “the agent said it’s done”
16+
Chat plans. Workspace is truth.
2117

22-
**For operators who want evidence before completion.**
18+
Most coding agents stop at chat. JoyZoning adds task tracking, real repo execution, verification workflows, audit trails, and merge only when you approve — so work stays reviewable before it becomes “done.”
2319

24-
> Chat plans; Workspace is truth.
20+
JoyZoning is not:
2521

26-
> **New here?** [What's next](docs/onboarding/whats-next.md) (~20 min after install) · [Onboarding hub](docs/onboarding/README.md)
22+
- a second IDE
23+
- an autonomous auto-merge bot
24+
- “the agent said it’s done”
2725

28-
---
29-
30-
## Onboarding in four steps
31-
32-
```mermaid
33-
flowchart LR
34-
P0[Phase 0 — Decide] --> P1[Phase 1 — Install]
35-
P1 --> P2[Phase 2 — First merge]
36-
P2 --> P3[Phase 3 — Scale]
37-
```
26+
For operators who want evidence before completion.
3827

39-
| Phase | Goal | Time | Go to |
40-
|-------|------|------|--------|
41-
| **0 — Decide** | Confirm JoyZoning matches your workflow | ~5 min | [Before you begin](docs/onboarding/before-you-begin.md) |
42-
| **1 — Install** | App running, health grade visible, repo opened | ~15 min | [5-minute quickstart](docs/onboarding/quickstart.md) |
43-
| **2 — First merge** | One card: dispatch → verify → merge → Complete | ~20 min | **[What's next](docs/onboarding/whats-next.md)** ← main walkthrough |
44-
| **3 — Scale** | Daily habits, CLI, or multi-role JSDP | ongoing | [Setup checklist](docs/onboarding/setup-checklist.md) · [JSDP](docs/jsdp.md) |
45-
46-
> One local [diet-hermes](https://github.com/NousResearch/hermes-agent). Not “the agent said it’s finished.”
28+
**New here?** [What's next](docs/onboarding/whats-next.md) (~20 min after install)
29+
**Full onboarding:** [onboarding/README.md](docs/onboarding/README.md)
4730

4831
---
4932

50-
## Phase 0 — Is JoyZoning for you?
33+
## Onboarding in four steps
5134

52-
| You want to… | JoyZoning is a good fit |
53-
|--------------|-------------------------|
54-
| Supervise agents on a **real repo** with an audit trail | Yes |
55-
| **Approve** what ships (diff + tests + your sign-off) | Yes |
56-
| Replace your IDE or use only chat | No — keep Cursor/VS Code; JoyZoning is the **cockpit** |
57-
| Unattended auto-merge with no human gate | No — merge is always operator-owned |
35+
| Step | Goal | Time | Guide |
36+
|------|------|------|--------|
37+
| **0 — Decide** | Is this the workflow you want? | ~5 min | [Before you begin](docs/onboarding/before-you-begin.md) |
38+
| **1 — Install** | App running, repo opened | ~15 min | [Quickstart](docs/onboarding/quickstart.md) |
39+
| **2 — First merge** | Dispatch → verify → merge → Complete | ~20 min | **[What's next](docs/onboarding/whats-next.md)** |
40+
| **3 — Daily use** | Desktop, CLI, or both | ongoing | [Setup checklist](docs/onboarding/setup-checklist.md) |
5841

59-
**Still unsure?** [Before you begin](docs/onboarding/before-you-begin.md) · [What is JoyZoning?](docs/what-is-joyzoning.md) (plain English)
42+
---
6043

61-
### Mental model (read once — used in every step)
44+
## Step 0 — Fit check
6245

63-
1. **Chat plans; Workspace is truth** — Manager Chat = thinking; **Workspace** = files on disk (like a PR “Files changed” tab). Trust Workspace, not chat, for sign-off.
64-
2. **One card → one branch** — You open one project folder. After **Dispatch**, work is on `joyzoning/card-<task-id>` in that folder (no hidden sandbox copy).
65-
3. **Only you merge** — Agents stop at `ready_for_review`; **Complete** is yours after review (and verification if you run it).
46+
| You want… | Good fit? |
47+
|-----------|-----------|
48+
| Supervised agent work on a **real repo** with an audit trail | Yes |
49+
| Review diffs and tests before anything ships | Yes |
50+
| A replacement IDE or chat-only workflow | No — keep your editor; use JoyZoning to supervise |
6651

67-
[Full philosophy](docs/philosophy.md) · [Which folder am I viewing?](docs/workspace-state.md)
52+
[What is JoyZoning?](docs/what-is-joyzoning.md) (plain English)
6853

6954
---
7055

71-
## Phase 1 — Install and open your repo
72-
73-
### Prerequisites
56+
## Step 1 — Install
7457

75-
- [ ] [.NET 8 SDK](https://dotnet.microsoft.com/download)`dotnet --version` shows 8.x (`global.json` in repo)
76-
- [ ] Node.js 18+ and **pnpm**
77-
- [ ] Python 3.11 (first-time Hermes setup only)
78-
- [ ] One **diet-hermes** install — [Hermes setup guide](docs/onboarding/hermes-setup.md)
79-
- [ ] LLM API key (before Manager Chat can reply) — [api-keys-and-models](docs/onboarding/api-keys-and-models.md)
80-
81-
### Commands
58+
**Need:** [.NET 8](https://dotnet.microsoft.com/download), Node 18+, pnpm, Python 3.11 (first Hermes setup), one [diet-hermes](https://github.com/NousResearch/hermes-agent) install ([guide](docs/onboarding/hermes-setup.md)), LLM API key for chat ([keys](docs/onboarding/api-keys-and-models.md)).
8259

8360
```bash
8461
git clone https://github.com/CardSorting/JoyZoning.git
8562
cd JoyZoning
86-
pnpm install
87-
pnpm setup # interactive: ports, workspace, Python venv
88-
pnpm dev # control plane + desktop + watch UI
63+
pnpm install && pnpm setup && pnpm dev
8964
```
9065

91-
**Desktop-only shortcut:** `./scripts/run-dev.sh` after clone — details in [quickstart](docs/onboarding/quickstart.md).
92-
93-
### You are ready for Phase 2 when…
94-
95-
| Check | Where to look |
96-
|-------|----------------|
97-
| JoyZoning window is open | Desktop app |
98-
| Health is **Healthy** or **Degraded** (not **Blocked**) | **Getting Started** |
99-
| Status chips for API / Dashboard are green or yellow | Top status bar — [status indicators](docs/onboarding/status-indicators.md) |
100-
| Your repo is selected | **Project → Open Workspace** |
66+
Or: `./scripts/run-dev.sh`[quickstart](docs/onboarding/quickstart.md).
10167

102-
First Hermes install can take **3–8 minutes** on a cold machine — normal.
103-
104-
**Ports (local only):** JoyZoning `9470` · Hermes API `8642` · Hermes dashboard `9119`
68+
**Ready for Step 2 when:** app open, health not **Blocked**, your repo selected (**Project → Open Workspace**). First Hermes setup may take a few minutes.
10569

10670
---
10771

108-
## Phase 2 — Your first supervised task
72+
## Step 2 — First task (dispatch → merge)
10973

110-
This is the habit you will repeat for every card. **Step-by-step with screenshots-level detail:** [What's next after setup](docs/onboarding/whats-next.md).
74+
Full walkthrough: **[What's next](docs/onboarding/whats-next.md)**.
11175

112-
```mermaid
113-
flowchart LR
114-
P[Plan] --> K[Kanban]
115-
K --> D[Dispatch]
116-
D --> W[Work]
117-
W --> V[Verify]
118-
V --> R[ready_for_review]
119-
R --> M[You merge]
120-
```
76+
| Step | Where | What you do | Done when… |
77+
|------|--------|-------------|------------|
78+
| **Plan** | Manager Chat | Describe the work | You have a reply |
79+
| **Track** | Kanban | Create or pick a card | Card is on the board |
80+
| **Dispatch** | Kanban | Start the agent on that card | Task activity shows a run |
81+
| **Review files** | Workspace | Check changed files | You see the real diff |
82+
| **Verify** | Workspace or `jz` | Run tests/build you care about | Status is ready for your review |
83+
| **Merge** | Workspace → Kanban | Approve the change | Card is **Complete** |
12184

122-
| Step | Open in app | You do | Success signal |
123-
|------|-------------|--------|----------------|
124-
| **1. Plan** | **Manager Chat** | Describe the outcome; optional **→ Task** | Assistant replies (needs API key) |
125-
| **2. Track** | **Kanban** | Create or select a card; use **Low** risk while learning | Card visible on board |
126-
| **3. Dispatch** | **Kanban** | **Dispatch** (approve if critical) | Execution viewport shows activity |
127-
| **4. Observe** | **Execution** / **Timeline** | Watch the run — chat is not sign-off | Events in Timeline |
128-
| **5. Verify** | **Workspace** or Terminal | Run tests/build you care about | Lease → `ready_for_review` |
129-
| **6. Merge** | **Workspace****Kanban** | Review diff; **Merge** when satisfied | Card **Complete** |
85+
Trust **Workspace**, not chat, for sign-off.
13086

131-
**No Terminal?** [Desktop menu guide](docs/onboarding/desktop-menu-guide.md) — where to click for each step.
132-
**Words unfamiliar?** [Plain-language glossary](docs/onboarding/plain-language-glossary.md).
133-
134-
### Terminal (same steps)
87+
**Menus, not terminal:** [desktop menu guide](docs/onboarding/desktop-menu-guide.md) · **Glossary:** [plain-language](docs/onboarding/plain-language-glossary.md)
13588

13689
```bash
137-
./scripts/jz doctor
13890
jz task run <task-id> --poll 10
13991
jz task verify <task-id> --cmd "dotnet test"
14092
jz task complete <task-id> --yes
141-
jz task watch <task-id>
14293
```
14394

14495
---
14596

146-
## Phase 3 — Choose how you work day to day
147-
148-
Same rules on every surface — pick what fits you:
97+
## Step 3 — Daily use
14998

150-
| Path | Best for | Start here |
151-
|------|----------|------------|
152-
| **Desktop** | Board, diffs, approvals, checklist | [quickstart](docs/onboarding/quickstart.md) |
153-
| **`jz` CLI** | Scripts, SSH, automation | [first-run-cli](docs/onboarding/first-run-cli.md) |
154-
| **Both** | Plan in UI, verify in terminal | [choose-your-path](docs/onboarding/choose-your-path.md) |
155-
| **Browser console** | Watch UI at `http://127.0.0.1:9470` | After `pnpm dev` |
156-
| **8-role delivery** | Product → architecture → … → QA in sequence | [jsdp.md](docs/jsdp.md) |
99+
| How you work | Start here |
100+
|--------------|------------|
101+
| Desktop (board + diffs) | [quickstart](docs/onboarding/quickstart.md) |
102+
| Terminal (`jz`) | [first-run-cli](docs/onboarding/first-run-cli.md) |
103+
| Both | [choose-your-path](docs/onboarding/choose-your-path.md) |
104+
| Browser UI (`http://127.0.0.1:9470`) | After `pnpm dev` |
157105

158-
### Multi-role programs (JSDP)
106+
**Habits:** one active task run per card · verify before merge · trust Workspace for review · start with low risk while learning.
159107

160-
One role at a time, **accept-merge between roles**, same repo throughout:
161-
162-
```bash
163-
./scripts/role-chain-dispatch.sh --create --workspace /path/to/repo --program "My App"
164-
./scripts/role-chain-dispatch.sh --status
165-
./scripts/role-chain-dispatch.sh --next
166-
jz task complete <task-id> --yes
167-
```
108+
[Use cases](docs/use-cases.md) · [FAQ](docs/faq.md)
168109

169-
### Habits that scale
110+
---
170111

171-
| Habit | Why |
172-
|-------|-----|
173-
| One active lease per card | Avoids conflicting branches |
174-
| Verify before merge | Evidence in the audit trail |
175-
| Trust **Workspace**, not chat, for sign-off | Cognition vs authority |
176-
| Start at **Low** risk until the loop feels natural | Fewer approval interrupts |
112+
## Stuck?
177113

178-
[Use cases](docs/use-cases.md) · [concepts](docs/concepts.md) · [FAQ](docs/faq.md)
114+
| Problem | Fix |
115+
|---------|-----|
116+
| App won't open | [Setup troubleshooting](docs/onboarding/troubleshooting-setup.md) |
117+
| Red API / Dashboard | [Status indicators](docs/onboarding/status-indicators.md) |
118+
| Chat won't reply | [API keys](docs/onboarding/api-keys-and-models.md) |
119+
| Empty Workspace | Dispatch the card first, then re-select it |
120+
| `jz` errors | [first-run-cli](docs/onboarding/first-run-cli.md) |
179121

180122
---
181123

182-
## Pick a shortcut (if you are not doing Phase 0→2 in order)
183-
184-
| You are… | Jump to |
185-
|----------|---------|
186-
| New — desktop first | [quickstart](docs/onboarding/quickstart.md)[whats-next](docs/onboarding/whats-next.md) |
187-
| From Hermes chat only | [coming-from-hermes-chat](docs/onboarding/coming-from-hermes-chat.md) |
188-
| Coding agent / Cursor | [AGENTS.md](AGENTS.md) |
189-
| Something broke | [troubleshooting-setup](docs/onboarding/troubleshooting-setup.md) |
124+
## Advanced — multi-role delivery (optional)
190125

191-
---
126+
After the basic loop feels natural, you can run **sequential roles** on one repo (e.g. product → architecture → implementation → QA) with a merge between each role. Same repo throughout; one role at a time.
192127

193-
## Stuck?
128+
```bash
129+
./scripts/role-chain-dispatch.sh --create --workspace /path/to/repo --program "My App"
130+
./scripts/role-chain-dispatch.sh --next
131+
jz task complete <task-id> --yes
132+
```
194133

195-
| Symptom | Fix |
196-
|---------|-----|
197-
| App won't open | [Setup troubleshooting](docs/onboarding/troubleshooting-setup.md) |
198-
| Red **API** or **Dashboard** chip | [status-indicators](docs/onboarding/status-indicators.md) |
199-
| Manager Chat never replies | [api-keys-and-models](docs/onboarding/api-keys-and-models.md) |
200-
| Workspace empty after agent worked | Card not **Dispatched** — dispatch, re-select card |
201-
| `jz` command fails | [first-run-cli](docs/onboarding/first-run-cli.md) |
202-
| Old `.joyzoning/worktrees` folders on disk | Safe to remove — [jsdp.md](docs/jsdp.md) |
134+
Details: [jsdp.md](docs/jsdp.md) · Technical background: [philosophy.md](docs/philosophy.md)
203135

204136
---
205137

206-
## Documentation map
138+
## Docs
207139

208-
| Stage | Docs |
140+
| Topic | Link |
209141
|-------|------|
210-
| Onboarding (all guides) | [onboarding/README.md](docs/onboarding/README.md) |
211-
| Install deep-dive | [installation](docs/onboarding/installation.md) · [macOS](docs/onboarding/platform-macos.md) · [Linux](docs/onboarding/platform-linux.md) |
212-
| Integrate / API | [control-plane-api](docs/control-plane-api.md) · [hermes-integration](docs/hermes-integration.md) |
142+
| All onboarding | [onboarding/README.md](docs/onboarding/README.md) |
143+
| Install (deep) | [installation](docs/onboarding/installation.md) |
144+
| API | [control-plane-api](docs/control-plane-api.md) |
213145
| Contribute | [development](docs/development.md) · [CONTRIBUTING](CONTRIBUTING.md) |
214146

215147
---

0 commit comments

Comments
 (0)