@evolvehq/docflow 0.9.0 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/USAGE.md +30 -0
- package/package.json +4 -3
package/USAGE.md
CHANGED
|
@@ -239,6 +239,7 @@ picks; a fully-specified request lets you skip straight through.
|
|
|
239
239
|
| `/audit` | Lints the repo against its own conventions and reports a punch list — numbering, INDEX sync, plan coverage, section completeness, status validity, cross-refs, language mandate, and **ADR-privacy leaks into user-visible code**. Offers to fix the mechanical issues. |
|
|
240
240
|
| `/brainstorm` | Decomposes a problem into candidate ADRs + plan items with dependency edges and ordering. Proposes drafts only; writes nothing until approved, then hands off to `/new-adr` and `/new-plan`. |
|
|
241
241
|
| `/agent-wave` | Orchestrates parallel worktree subagents over the queue. Asks wave width, budget (items/waves; hours as a soft cap), and supervision (checkpoint vs. continuous). Requires multi-agent mode; refuses mode 1. |
|
|
242
|
+
| `/rollup` | For a **multi-repo product**: from the home repo, aggregate every member repo's `INDEX` into one derived, product-wide roll-up. Members not checked out are listed as "not aggregated this run". |
|
|
242
243
|
|
|
243
244
|
### agent-wave: what it can and can't do
|
|
244
245
|
|
|
@@ -254,6 +255,35 @@ It requires a multi-agent mode (Q5 mode 2 or 3) and works best in mode
|
|
|
254
255
|
Continuous-unsupervised runs are recommended only with PR-based
|
|
255
256
|
integration, so CI gates each merge.
|
|
256
257
|
|
|
258
|
+
### Multi-repo products (federation)
|
|
259
|
+
|
|
260
|
+
A single product spread across several repos runs as a **federation**.
|
|
261
|
+
Bootstrap asks whether the repo is standalone or part of a multi-repo
|
|
262
|
+
product, and — if the latter — whether it is **establishing** a new
|
|
263
|
+
federation or **joining** an existing one. A joining repo writes only its
|
|
264
|
+
own `federation.md` back-pointer; it never writes into another repo, and
|
|
265
|
+
it inherits the topology and identity scheme rather than re-choosing them.
|
|
266
|
+
|
|
267
|
+
- **Topology** (chosen at establishment): a central decisions repo · a
|
|
268
|
+
distributed set · or a home repo with local decisions alongside (the
|
|
269
|
+
default).
|
|
270
|
+
- **Identity & numbering.** Numbering stays contiguous *per repo*; a
|
|
271
|
+
federation-wide identity — by default a repo-prefixed slug
|
|
272
|
+
`<repo-id>/NNNN-slug` — is the cross-repo key, so two repos never
|
|
273
|
+
collide.
|
|
274
|
+
- **References.** Cross-repo links use the logical identity, resolved via
|
|
275
|
+
the home's `federation-index.md`; same-repo links stay relative.
|
|
276
|
+
- **`/rollup`** aggregates every member's catalogue into one product-wide
|
|
277
|
+
view; **`/audit`** gains cross-repo checks (bidirectional membership,
|
|
278
|
+
identity collisions, dangling references, roll-up drift).
|
|
279
|
+
- **Conventions** are copied at bootstrap and kept honest by audit
|
|
280
|
+
drift-detection — referenceable from the home, never force-pushed.
|
|
281
|
+
|
|
282
|
+
No tool writes across a repo boundary: consistency is declared at the
|
|
283
|
+
edges and enforced by audit. See the
|
|
284
|
+
[methodology](https://evolvehq.github.io/docflow/methodology/#5-scaling-to-many-repositories)
|
|
285
|
+
for the formal model.
|
|
286
|
+
|
|
257
287
|
### Enabling an optional convention later (worked example: TDD)
|
|
258
288
|
|
|
259
289
|
docflow's bootstrap is deliberately lean — practices such as
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@evolvehq/docflow",
|
|
3
|
-
"version": "0.9.
|
|
4
|
-
"description": "ADR-driven documentation workflow: scaffold an Architecture Decision Record (ADR) catalogue, a plan/ queue, and AGENTS.md conventions into any repo, then author, queue, ship, and
|
|
3
|
+
"version": "0.9.1",
|
|
4
|
+
"description": "ADR-driven documentation workflow: scaffold an Architecture Decision Record (ADR) catalogue, a plan/ queue, and AGENTS.md conventions into any repo, then author, queue, ship, audit, and roll up ADRs with lifecycle skills — across one repo or a multi-repo product. Works on Claude Code, Claude Cowork, pi, Codex, and OpenCode.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"pi-package",
|
|
7
7
|
"adr",
|
|
8
8
|
"architecture-decision-records",
|
|
9
9
|
"documentation",
|
|
10
|
-
"claude-code"
|
|
10
|
+
"claude-code",
|
|
11
|
+
"multi-repo"
|
|
11
12
|
],
|
|
12
13
|
"license": "MIT",
|
|
13
14
|
"author": "Eugenio Minardi",
|