Skip to content

Commit c166369

Browse files
montfortclaude
andauthored
feat(framework): fw-4.14.1 — docs sync for batch-complete + Batch Ledger discoverability (#148)
Closes the documentation gap left by fw-4.14.0 / cli-3.13.0. The release added `straymark charter batch-complete` and the Batch Ledger workflow but did not surface them in three discovery surfaces: - Root README.md (EN + i18n/es + i18n/zh-CN): the "CLI Tools" feature bullet and the table-of-commands row both listed `charter <new|list|status|close|drift|audit>` without batch-complete. - dist/STRAYMARK.md §15 (Charter lifecycle): the lifecycle stage table jumped from "In progress" to "Drift check" with no mention of the per-batch ledger update pattern. Quick CLI surface block missed the batch-complete invocation. - Governance footers + version tables: still showing v4.14.0 / fw-4.14.0, hiding that a newer release exists. STRAYMARK.md is shipped to every adopter via `straymark init`; without a framework bump, `straymark update-framework` would not bring the canonical Charter lifecycle update. Hence the patch release rather than a docs-only PR without a tag. No behavior changes: CLI is unchanged (cli-3.13.0 still matches), no schemas or templates moved. The "Available since cli-3.13.0+ / fw-4.14.0+" annotations in CLI-REFERENCE are preserved as minimum-version markers (they document when the feature was introduced, not the current release). Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3d6dfd6 commit c166369

25 files changed

Lines changed: 81 additions & 54 deletions

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,31 @@ and this project uses [independent versioning](README.md#versioning) for Framewo
77

88
---
99

10+
## Framework 4.14.1 — Docs sync for batch-complete + Batch Ledger discoverability
11+
12+
Framework-only patch that closes the documentation gap left by `fw-4.14.0` / `cli-3.13.0`. The release added the `batch-complete` subcommand and the Batch Ledger workflow but didn't surface them in three places adopters and contributors discover the project from: the root `README.md` (and i18n overlays), the project's user-facing comparison/feature lists, and **`dist/STRAYMARK.md`** — the governance file shipped to every adopter via `straymark init`.
13+
14+
### Changed (Framework)
15+
16+
- **`dist/STRAYMARK.md` §15 (Charter lifecycle)** — new "Batch update" stage row inserted between "In progress" and "Drift check", documenting the per-batch ledger update pattern and pointing at `straymark charter batch-complete CHARTER-NN <N>`. The "Drift check" row now mentions that pending `### Batch N` entries cause a hard fail (with `--no-batch-ledger-check` bypass).
17+
- **`dist/STRAYMARK.md` Quick CLI surface** — added the `batch-complete` line and annotated the `drift` line with "AILOG-aware + Batch Ledger gate".
18+
- **Governance footers** updated to `v4.14.1` across `QUICK-REFERENCE.md`, `AGENT-RULES.md`, `DOCUMENTATION-POLICY.md`, `C4-DIAGRAM-GUIDE.md`, `FOLLOW-UPS-BACKLOG-PATTERN.md` (EN + ES + zh-CN, plus the top-level `dist/.straymark/QUICK-REFERENCE.md`).
19+
20+
### Changed (Repo-level docs, not shipped via `straymark init`)
21+
22+
- **`README.md`** (root, EN + i18n/es + i18n/zh-CN) — "Features → CLI Tools" bullet expanded to include `batch-complete` and the Batch Ledger gate on `drift`; the table-of-commands row for `straymark charter <subcommand>` updated likewise.
23+
- **`docs/adopters/CLI-REFERENCE.md`** (EN + ES + zh-CN) — version tables + canonical-output examples bumped to `fw-4.14.1`. The detailed `batch-complete` section and the extended `drift` description added in `fw-4.14.0`/`cli-3.13.0` remain unchanged; their `*(cli-3.13.0+ + fw-4.14.0+)*` minimum-version annotations are intentionally preserved (those mark when the feature was introduced, not the current release).
24+
25+
### Why a patch release for docs only
26+
27+
The `dist/STRAYMARK.md` change is governance content shipped to every adopter — without bumping the framework, `straymark update-framework` would not bring the new content to existing installations. The cost of a patch tag is one CI run; the value is that any new or existing adopter who runs `straymark init` or `straymark update-framework` sees the canonical Charter lifecycle table with the Batch Ledger pattern visible.
28+
29+
### Adopter guidance
30+
31+
`straymark update-framework` brings the updated `STRAYMARK.md` and governance footers. No behavior changes: the CLI is unchanged (`cli-3.13.0` remains the matching CLI version), and no schemas or templates moved.
32+
33+
---
34+
1035
## Framework 4.14.0 / CLI 3.13.0 — Sentinel feedback cycle: shellcheck cleanup, regex extension, multi-batch AILOG ledger
1136

1237
Closes three upstream issues filed by Sentinel during its CHARTER-17 cycle, all field-validated downstream and ready for upstream canonization. The unifying theme is **pre-announcement hardening**: each issue was discovered in real adopter usage, the fix is additive (zero ruptura para existing artifacts), and Sentinel can revert its local workaround once this release lands.

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Built-in safeguards ensure humans stay in control:
146146

147147
Built-in commands that turn the discipline into actionable feedback:
148148

149-
- **`straymark charter <new|list|status|close|drift|audit>`** — Bounded units of work declared ex-ante, audited ex-post. `close` records post-execution telemetry; `drift` detects file-vs-commit drift with AILOG-aware suppression; `audit` orchestrates a multi-model external review (3-step prepare/calibrate/finalize, orchestration-only — no LLM API calls). For IDE-driven workflows, the inline skills `/straymark-audit-prompt` and `/straymark-audit-review` wrap the CLI to surface prompts in the conversation and merge findings into telemetry.
149+
- **`straymark charter <new|list|status|close|drift|batch-complete|audit>`** — Bounded units of work declared ex-ante, audited ex-post. `close` records post-execution telemetry; `drift` detects file-vs-commit drift with AILOG-aware suppression and (cli-3.13.0+) gates on `### Batch N (pending)` entries in the AILOG `## Batch Ledger`; `batch-complete` (cli-3.13.0+) marks a batch as complete in the ledger for multi-batch Charters (3+ batches or >1 day); `audit` orchestrates a multi-model external review (3-step prepare/calibrate/finalize, orchestration-only — no LLM API calls). For IDE-driven workflows, the inline skills `/straymark-audit-prompt` and `/straymark-audit-review` wrap the CLI to surface prompts in the conversation and merge findings into telemetry.
150150
- **`straymark approve <doc-id>`** — Record a formal human approval (writes `reviewed_by` / `reviewed_at` / `review_outcome` and the `## Approval` body section in one edit; closes the gap canonized in DOCUMENTATION-POLICY §3.5)
151151
- **`straymark validate`** — 25+ validation rules for document correctness (12 China-specific are scope-aware); `--include-charters` extends to `.straymark/charters/`; `--check-pending-reviews` lists approval backlog (warn-only)
152152
- **`straymark metrics`** — Governance KPIs, review rates, risk distribution, trends
@@ -274,7 +274,7 @@ StrayMark uses independent version tags for each component:
274274

275275
| Component | Tag prefix | Example | Includes |
276276
|-----------|-----------|---------|----------|
277-
| Framework | `fw-` | `fw-4.14.0` | Templates (12 types), governance, directives, Charter template + schema |
277+
| Framework | `fw-` | `fw-4.14.1` | Templates (12 types), governance, directives, Charter template + schema |
278278
| CLI | `cli-` | `cli-3.13.0` | The `straymark` binary |
279279

280280
Check installed versions with `straymark status` or `straymark about`.
@@ -291,7 +291,7 @@ Check installed versions with `straymark status` or `straymark about`.
291291
| `straymark status [path]` | Show installation health and doc stats |
292292
| `straymark repair [path]` | Restore missing directories and framework files |
293293
| `straymark validate [path]` | Validate documents for compliance and correctness (use `--include-charters` for Charters, `--check-pending-reviews` for approval backlog) |
294-
| `straymark charter <subcommand>` | Manage Charters: `new`, `list`, `status`, `close` (record telemetry), `drift` (file-vs-commit drift with AILOG-awareness), `audit` (multi-model external review, orchestration-only) |
294+
| `straymark charter <subcommand>` | Manage Charters: `new`, `list`, `status`, `close` (record telemetry), `drift` (file-vs-commit drift with AILOG-awareness + Batch Ledger gate), `batch-complete` (mark a batch as complete in the AILOG `## Batch Ledger` for multi-batch Charters), `audit` (multi-model external review, orchestration-only) |
295295
| `straymark approve <doc-id>` | Record a formal human approval on a `review_required: true` document (frontmatter + canonical body section) |
296296
| `straymark compliance [path]` | Check regulatory compliance (EU AI Act, ISO 42001, NIST) |
297297
| `straymark metrics [path]` | Show governance metrics and documentation statistics |
@@ -307,7 +307,7 @@ See [CLI Reference](https://github.com/StrangeDaysTech/straymark/blob/main/docs/
307307
```bash
308308
# Download the latest framework release ZIP from GitHub
309309
# Go to https://github.com/StrangeDaysTech/straymark/releases
310-
# and download the latest fw-* release (e.g., fw-4.14.0)
310+
# and download the latest fw-* release (e.g., fw-4.14.1)
311311
312312
# Extract and copy to your project
313313
unzip straymark-fw-*.zip -d your-project/

dist/.straymark/00-governance/AGENT-RULES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,4 +379,4 @@ When a project accumulates a high volume of AILOGs across multiple Charters and
379379
380380
---
381381
382-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
382+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/C4-DIAGRAM-GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,4 @@ Use a Level 1 (Context) diagram to illustrate:
234234

235235
---
236236

237-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
237+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/DOCUMENTATION-POLICY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,4 +313,4 @@ See also [ADR-2025-01-20-001] for architectural context.
313313
314314
---
315315

316-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
316+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/FOLLOW-UPS-BACKLOG-PATTERN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,4 +233,4 @@ Contributed via [issue #111](https://github.com/StrangeDaysTech/straymark/issues
233233

234234
---
235235

236-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
236+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/QUICK-REFERENCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,4 +241,4 @@ Mark `review_required: true` when:
241241

242242
---
243243

244-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
244+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/i18n/es/AGENT-RULES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,4 +379,4 @@ Cuando un proyecto acumula un volumen alto de AILOGs a lo largo de múltiples Ch
379379
380380
---
381381
382-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
382+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/i18n/es/C4-DIAGRAM-GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,4 +234,4 @@ Usar un diagrama de Nivel 1 (Contexto) para ilustrar:
234234

235235
---
236236

237-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
237+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

dist/.straymark/00-governance/i18n/es/DOCUMENTATION-POLICY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,4 +306,4 @@ Ver también [ADR-2025-01-20-001] para contexto arquitectónico.
306306

307307
---
308308

309-
*StrayMark v4.14.0 | [Strange Days Tech](https://strangedays.tech)*
309+
*StrayMark v4.14.1 | [Strange Days Tech](https://strangedays.tech)*

0 commit comments

Comments
 (0)