Skip to content

Commit edf7de9

Browse files
roodboiclaude
andcommitted
docs: extend overhaul plan (run/exec defaulting, onboarding surfaces, docs phase)
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 58a023c commit edf7de9

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/plans/2026-07-07-worktree-ax-overhaul-plan.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,16 @@ and phase-out of tickets from default instructions.
9797
- Spec: `experimental: true` on node/dispatch/gateway/remote; default help hides them
9898
behind an "experimental (unsupported)" one-liner; runtime warning banner on use.
9999
- Respect `NO_COLOR` in gum/logger/help.
100+
- `hack run` / `hack exec` get the same linked-worktree branch defaulting as
101+
up/down/logs/open (via resolveEffectiveBranch) — closes the footgun where `up`
102+
targets the branch instance but a bare `run` hits the base instance.
103+
- New canonical "Running things" decision guide in instruction-source.ts: an explicit
104+
if-you-need-X-use-Y table covering `hack run` (one-off in service container),
105+
`hack exec` (inside running container), `hack host exec --env <overlay> --scope <svc>`
106+
(host scripts with injected env — THE way to run repo scripts that need hack-stored
107+
env), `hack host shell`, env overlays, and calling services via caddy hostnames
108+
(`https://api.<dev_host>`) from host or between containers. Rendered on all surfaces;
109+
also becomes the backbone of Phase 4's onboarding prompt.
100110

101111
### Phase 4 — Agent-assisted onboarding
102112
- `hack init --with claude|codex|both` (and `hack agent onboard` for existing projects):
@@ -105,9 +115,20 @@ and phase-out of tickets from default instructions.
105115
macOS-host installs never leak into linux containers), ops/tooling container pattern,
106116
`hack run` vs `exec` vs `host exec` vs env overlays guidance, verification loop
107117
(up → open --json → logs). Launch agent CLI if present, else print prompt.
118+
- Onboarding prompt content is a single module consumed by: the CLI flag, an agent-side
119+
skill/command (`/hack-init`) installed by `hack setup claude|codex`, an MCP prompt for
120+
no-shell clients, and a copy-paste block in the docs.
108121
- `docs/guides/agent-first-setup.md` + surface via `hack agent patterns` and the
109122
instruction source (Phase 1 section).
110123

124+
### Phase 5.5 — Docs overhaul + docs-currency enforcement
125+
- Fan-out audit of every docs/ file against actual code; remove removed/deprecated
126+
surfaces; refresh for everything this branch adds.
127+
- Generate the CLI command reference from CLI_SPEC (existing markdown help renderer)
128+
with a drift test so the reference can never rot.
129+
- Docs-currency rule added to repo CLAUDE.md/AGENTS.md and the instruction source
130+
maintenance section: interface/behavior changes must update docs in the same change.
131+
111132
### Phase 5 — Tickets phase-out + cleanup
112133
- Docs: tickets marked optional/legacy; removed from README quickstart and repo CLAUDE.md;
113134
`hack setup tickets` prints a deprecation-leaning note. Commands keep working.

0 commit comments

Comments
 (0)