You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Audit-driven rewrite of 27 files: docs-ia and cli.md rebuilt (cli.md
defers exhaustive flags to the generated reference), 7 architecture
stale claims fixed, env/sessions/lifecycle corrected (secret-key
inheritance order, tmux-only daemon sessions, envelope error codes),
experimental banner standardized across all remote/gateway docs,
tickets reframed as opt-in. Every relative link and documented
command verified against the generated CLI reference.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,13 @@ The docs are split into three areas so the default path stays on core local work
10
10
11
11
Use this path for the main product story:
12
12
13
-
- local project setup
14
-
- isolated runtime orchestration
13
+
- local project setup (including agent-assisted onboarding via `hack init --with` / `hack agent onboard` — see the [agent-first setup guide](guides/agent-first-setup.md))
14
+
- isolated runtime orchestration (including branch instances and linked worktrees)
15
15
- stable local hostnames
16
16
- env and secret management
17
17
- lifecycle hooks
18
18
- persistent sessions
19
+
- diagnostics (`hack doctor` / `hack doctor --fix`)
19
20
20
21
Start here if you want to understand and use `hack` without remote or beta complexity by default.
21
22
@@ -35,7 +36,7 @@ out of the default path.
35
36
36
37
Use this path for:
37
38
38
-
- full command reference
39
+
- full command reference: [CLI overview](cli.md) plus the generated [CLI reference](reference/cli.md) (every command and flag)
39
40
- extension configuration and authoring
40
41
- tickets and integrations
41
42
- gateway API and SDK details
@@ -45,14 +46,17 @@ This section is easy to find, but it does not lead the product story.
45
46
## Quick links
46
47
47
48
- New to `hack`: [Core docs](core.md)
49
+
- Setting up with a coding agent: [Agent-first setup](guides/agent-first-setup.md)
50
+
- Looking for command or API details: [Extensions & reference](reference.md), including the generated [CLI reference](reference/cli.md)
48
51
- Need unsupported experimental remote workflows: [Beta workflows](beta.md)
49
-
- Looking for command or API details: [Extensions & reference](reference.md)
50
52
- Need the bucket definitions: [Docs information architecture](docs-ia.md)
51
53
52
54
## Repo notes
53
55
54
-
-Specs remain in `SPECS/` as working notes
56
+
-Working notes and historical design docs live in `docs/plans/`; they are not the supported product contract
55
57
- Root scripts orchestrate workspace tasks through Turbo
56
58
- Package-local commands remain available via `bun run --cwd <workspace> <script>`
57
-
- Agent-facing docs and setup output are generated from `src/agents/*` and `src/mcp/agent-docs.ts`; update those renderers when changing AGENTS/Codex/MCP guidance.
59
+
- Agent-facing docs and setup output are generated from `src/agents/instruction-source.ts` via `src/agents/*` and `src/mcp/agent-docs.ts`; update the canonical source (not the rendered surfaces) when changing AGENTS/Codex/MCP guidance.
60
+
- The generated [CLI reference](reference/cli.md) is rendered from the command spec (`bun run docs:cli-reference`); a drift test fails when it is stale.
61
+
- End-to-end coverage that backs docs claims lives in `tests/e2e/` (`bun run test:e2e:local`).
58
62
-`.factory/validation/` contains historical evidence from retired hosted/web/integration work and is not the current product contract.
Copy file name to clipboardExpand all lines: docs/beta.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Beta Workflows
2
2
3
+
> **Status: unsupported experimental.** These surfaces are source-available but outside the supported v3 product contract. They are hidden from default `hack --help` (see `hack help --all`) and print a warning when invoked.
4
+
3
5
This section holds unsupported experimental remote workflows.
4
6
5
7
Start in [Core docs](core.md) first if you are new to `hack`. Beta workflows build on the core
0 commit comments