From da636abb8a681f6a5aaab6b2a34939d0260ad280 Mon Sep 17 00:00:00 2001 From: "operator-stack-publisher[bot]" Date: Sat, 25 Jul 2026 15:07:01 +0000 Subject: [PATCH] Sync Boatstack from Intelligence Flow Labs @ dc521a60a4a3 --- CONTRIBUTING.md | 2 +- README.md | 54 +++++++++---------- UPSTREAM.json | 13 ++--- docs/evidence-engineered-coding.md | 2 +- docs/public-claims.json | 24 ++++----- labs/diagram-json/plan.lock.json | 2 +- ...-25-readme-simplified-technical-english.md | 17 ++++++ 7 files changed, 66 insertions(+), 48 deletions(-) create mode 100644 release-notes/2026-07-25-readme-simplified-technical-english.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1a53f1..bce6c35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ # Contributing -Boatstack is a generated content distribution. Propose changes to workflow semantics, templates, evidence rules, or generated presentation in [Intelligence Flow](https://github.com/operatorstack/intelligence-flow/tree/719220d52b8ac1237c9169099b53a024dc583cc6/labs/12-product-engineering-loop). +Boatstack is a generated content distribution. Propose changes to workflow semantics, templates, evidence rules, or generated presentation in [Intelligence Flow](https://github.com/operatorstack/intelligence-flow/tree/dc521a60a4a3dc03405d545ca63feaa753087b54/labs/12-product-engineering-loop). The Boatstack repository receives product/runtime changes through a generated pull request. Review the PR's `UPSTREAM.json`, tests, adapter diff, and context-size change; do not hand-edit generated output on `main`. `.github/workflows` is the exception: it is Boatstack's executable control plane, excluded from scheduled projection and changed only through a separate manually reviewed Boatstack PR. diff --git a/README.md b/README.md index 4bcfc2a..24f1082 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ Boatstack is a repository-local delivery harness for Cursor, Codex, Claude Code, and Gemini CLI. -AI coding agents can write code quickly, but each tool brings its own planning flow, session state, and definition of “done.” Change agents and your delivery process often disappears with the chat. +AI coding agents write code quickly. But each tool brings its own planning flow, session state, and definition of "done". If you change agents, your delivery process often disappears with the chat. -Boatstack keeps the delivery process in the repository. Plans, product decisions, tests, review findings, accepted gaps, and completion evidence stay connected from idea to pull request, regardless of which agent or model performs the work. Use Cursor, Codex, Claude Code, or Gemini CLI. Boatstack keeps the same approval, testing, review, and shipping boundaries across them. +Boatstack keeps the delivery process in the repository. Your plans, product decisions, tests, review findings, accepted gaps, and completion evidence stay connected from idea to pull request. This holds no matter which agent or model does the work. Use Cursor, Codex, Claude Code, or Gemini CLI. Boatstack keeps the same approval, testing, review, and shipping boundaries across all of them. **Your product development flow stays with the repository, not the coding agent.** Change agents, models, or specialist skills without rebuilding how your team plans, verifies, reviews, and ships software. @@ -49,17 +49,17 @@ Boatstack does not preserve an agent's private reasoning or replay old chats. It - review findings - verified repository state -That means the next feature starts from recorded project knowledge instead of reconstructing intent from another agent session. +So the next feature starts from recorded project knowledge. You do not reconstruct intent from another agent session. ## Prevent systemic failure instead of patching symptoms -When coding agents or developers encounter a bug, they instinctively patch the local symptom. The underlying architectural flaw—like a leaky database edge that blindly accepts bad data—remains open, guaranteeing the exact same failure will happen again elsewhere. +When coding agents or developers meet a bug, they usually patch the local symptom. The underlying architectural flaw stays open — for example, a database edge that accepts bad data. The same failure then happens again elsewhere. -When you ask for a fix during `/auto-plan`, Boatstack actively scans your codebase to determine if the bug is a symptom of a missing systemic boundary. Instead of silently patching the symptom, it pauses and asks if you want to establish a programmatic lock (like a database trigger or strict validator). +When you ask for a fix during `/auto-plan`, Boatstack scans your codebase. It checks whether the bug is a symptom of a missing systemic boundary. If it is, Boatstack pauses instead of patching the symptom. It then asks whether you want to add a programmatic lock, such as a database trigger or a strict validator. -For a bug you want diagnosed first, run `/root-cause ` (paste a stack trace, error, or failing signal). It is strictly read-only: it locates the failure below its surface symptom, names the failure *class*, traces a cited root-cause chain, maps the blast radius, and proposes the structural change that eliminates the whole class. It ends by producing a source plan you save and hand to `/auto-plan --plan ` — the diagnostic front door to the plan gate. +To diagnose a bug first, run `/root-cause ` and paste a stack trace, an error, or a failing signal. The operation is strictly read-only. It locates the failure below its surface symptom. It names the failure *class*. It traces a cited root-cause chain, maps the blast radius, and proposes the structural change that removes the whole class. It ends with a source plan. Save that plan and pass it to `/auto-plan --plan `, the diagnostic front door to the plan gate. -By turning one-off bug fixes into systemic constraints, your codebase gets safer with every agent run. Boatstack requires a negative test to prove the new lock is impenetrable. Upon publication, it extracts that verified boundary into the repository's global memory, ensuring all future agent runs are strictly bound by the new law of physics. +Boatstack turns one-off bug fixes into systemic constraints, so your codebase gets safer with every agent run. It requires a negative test that proves the new lock holds. On publication, it records that verified boundary in the repository's global memory. All future agent runs are then bound by the new rule. ## Install with your coding agent @@ -69,7 +69,7 @@ Copy this into Cursor, Codex, Claude Code, or Gemini CLI while the repository is Install Boatstack in this repository from https://github.com/operatorstack/boatstack. Detect whether you are running in Cursor, Codex, Claude Code, or Gemini CLI; create or use a chore/install-boatstack branch; run the official installer for this operating system; default to core unless I request gstack or Spec Kit; keep all portable host adapters; run Boatstack doctor; show me the generated files and installation diff; and prepare the installation PR without merging it or starting product work. ``` -Install Boatstack in its own infrastructure PR and merge it before starting a feature. Install once per Git clone; linked worktrees reuse the verified runtime and restore their ignored local helper automatically. +Install Boatstack in its own infrastructure PR. Merge that PR before you start a feature. Install once per Git clone. Linked worktrees reuse the verified runtime and restore their ignored local helper automatically. ## Start with two moves @@ -85,13 +85,13 @@ Install Boatstack in its own infrastructure PR and merge it before starting a fe That is all you need to learn up front. Boatstack shows one next action at a time through approval, building, tests, review, and PR preparation. -When you return after an interruption, run `/boatstack-next` in Claude Code, Cursor, or Gemini CLI, or `$boatstack next` in Codex. Boatstack reports the repository-verified stage and one next action without changing state. It distinguishes a feature that has not started from one that is complete. +When you return after an interruption, run `/boatstack-next` in Claude Code, Cursor, or Gemini CLI. In Codex, run `$boatstack next`. Boatstack reports the repository-verified stage and one next action. It does not change state. It tells apart a feature that has not started from one that is complete. -`$boatstack run` in Codex or `/boatstack-run` in Claude Code, Cursor, and Gemini CLI starts from one saved plan and continues through publication, pausing for approvals and product decisions. It checks branch freshness before delivery; it never merges or deploys. +`/boatstack-run` (or `$boatstack run` in Codex) starts from one saved plan. It continues through publication and pauses for approvals and product decisions. It checks branch freshness before delivery. It never merges or deploys. In Claude Code, Cursor, and Gemini CLI, that guidance moves through `/plan-gate` → `/build` → `/test-gate` → `/review-gate` → `/ship-gate`. In Codex, use the same operation names after `$boatstack`. -> The diagram shows what Boatstack guides—not a checklist you need to memorize. +> The diagram shows what Boatstack guides. It is not a checklist you must memorize.

One feature moves from idea through planning, approval, building, tests, review, and pull request; its retained plans, decisions, gaps, evidence, and code state combine with the next idea to create the next plan @@ -99,14 +99,14 @@ In Claude Code, Cursor, and Gemini CLI, that guidance moves through `/plan-gate` ## Change course without losing the delivery -After Build, describe changes normally. Boatstack records them, preserves valid work, and resumes at the earliest boundary. You do not need to remember a repair command: ordinary CI failures, review findings, and denied publication attempts route automatically for active deliveries and published PRs. +After Build, describe changes normally. Boatstack records them, keeps valid work, and resumes at the earliest boundary. You do not need to remember a repair command. Ordinary CI failures, review findings, and denied publication attempts route automatically for active deliveries and published PRs. ```text -“This is wrong” → record → repair → test → review +"This is wrong" → record → repair → test → review ↘ changed intent → approve delta ``` -Receipts remain as history; published corrections become independently approved linked deliveries. An open PR is updated after fresh gates, while merged or closed work receives a new PR. +Receipts stay as history. Published corrections become independently approved, linked deliveries. Boatstack updates an open PR after fresh gates. For merged or closed work, it opens a new PR. ## What you get @@ -120,22 +120,22 @@ Receipts remain as history; published corrections become independently approved

Technical Features - **A guided path from idea to PR.** `/auto-plan` starts a one-action-at-a-time delivery flow. -- **Instant orientation after a break.** `boatstack next` reconstructs the verified stage without treating chat or a running process as workflow evidence, so you resume in seconds instead of re-reading history. -- **Human decisions stay human.** Material product questions remain open until a person answers them, and implementation waits for explicit approval. -- **Evidence tied to the promise.** Tests and checks map to the outcomes the change claims to deliver instead of treating one green command as proof of everything. -- **Context that survives the feature.** Plans, decisions, gaps, evidence, and code state remain useful beyond the chat. -- **Conversational repair after Build.** Describe what changed; Boatstack preserves valid work and reruns only affected boundaries. +- **Instant orientation after a break.** `boatstack next` reconstructs the verified stage. It does not treat chat or a running process as workflow evidence. You resume in seconds instead of re-reading history. +- **Human decisions stay human.** Material product questions stay open until a person answers them. Implementation waits for explicit approval. +- **Evidence tied to the promise.** Tests and checks map to the outcomes the change claims to deliver. One green command is not proof of everything. +- **Context that survives the feature.** Plans, decisions, gaps, evidence, and code state stay useful beyond the chat. +- **Conversational repair after Build.** Describe what changed. Boatstack keeps valid work and reruns only the affected boundaries. - **Safer agent execution.** High-confidence destructive recovery is stopped before execution; phased work is gated and published one approved delivery slice at a time. -- **Reviewer-ready pull requests.** Actual changes, evidence, risks, rollout, and rollback become a focused PR brief, so reviewers spend time on judgment, not reconstruction. +- **Reviewer-ready pull requests.** Actual changes, evidence, risks, rollout, and rollback become a focused PR brief. Reviewers spend time on judgment, not reconstruction. - **Optional repository changelog.** Require readable `CHANGELOG.md` entries grounded in actual changes. - **Portable across your AI stack.** Hosts, models, and skills share one repository-owned delivery contract. -- **Repository-friendly maintenance.** Worktrees restore runtime; updates stay in separate infrastructure PRs. +- **Repository-friendly maintenance.** Worktrees restore runtime. Updates stay in separate infrastructure PRs. ## Configure repository policy -`.boatstack-project.json` controls the project commands and context Boatstack uses, which coding hosts it supports, and opt-in policies for changelogs, boundary analysis, high-risk review, and feature workspaces. [Choose the outcomes you want and see every configuration field](docs/configuration.md). +`.boatstack-project.json` controls three things: the project commands and context Boatstack uses, the coding hosts it supports, and the opt-in policies for changelogs, boundary analysis, high-risk review, and feature workspaces. [Choose the outcomes you want and see every configuration field](docs/configuration.md). ## How Boatstack fits into your AI stack @@ -151,14 +151,14 @@ Boatstack is a repository-local delivery harness. > **Designed for model flexibility · Quality uplift evaluation in progress** - **Verified:** the same completion requirements apply regardless of model, provider, or price. -- **Observed:** benchmark runs exposed failures in protocol handling, context, verification, and recovery—not only model capability. +- **Observed:** benchmark runs exposed failures in protocol handling, context, verification, and recovery — not only model capability. - **Being evaluated:** whether this improves product quality, cost, or delivery time with lower-cost models. This does not mean every model performs equally. [See the evidence and paired evaluation design](docs/why-these-steps.md#model-choice-and-budget). ## Built from failures observed in real coding work -They derive from coding failures observed in benchmark and product work—not guesses. When a failure reveals a reusable delivery problem rather than a project-specific mistake, Boatstack turns it into a boundary future runs can enforce. Each link explains what happened, what Boatstack does, and whether that behavior has actually been tested. +These behaviors come from coding failures observed in benchmark and product work, not from guesses. When a failure reveals a reusable delivery problem rather than a project-specific mistake, Boatstack turns it into a boundary that future runs enforce. Each link explains what happened, what Boatstack does, and whether that behavior has actually been tested. | What happened | What Boatstack does | Current evidence | |---|---|---| @@ -173,13 +173,13 @@ They derive from coding failures observed in benchmark and product work—not gu ## A small example -A request asked to “Add a password reset button,” but the product used passwordless sign-in. Boatstack flagged the conflict. The developer chose dual authentication; later, review caught an unsafe recovery assumption and prompted a repair. +A request asked to "Add a password reset button". But the product used passwordless sign-in. Boatstack flagged the conflict. The developer chose dual authentication. Later, review caught an unsafe recovery assumption and prompted a repair. [Follow the sanitized walkthrough](docs/account-recovery-walkthrough.md) or [ship your first feature](docs/getting-started.md). ## Updates stay out of product work -After a PR is published, Boatstack may report a new stable release without changing the feature branch. `/boatstack-update` prepares a separate infrastructure branch, shows the diff, and waits for `open update PR`. It never merges the update. +After you publish a PR, Boatstack may report a new stable release. It does not change the feature branch. `/boatstack-update` prepares a separate infrastructure branch, shows the diff, and waits for `open update PR`. It never merges the update.
Install manually @@ -212,6 +212,6 @@ The installer previews generated paths, verifies the platform helper, offers opt ## Project status -Boatstack is an open-source research prototype. Its workflow and enforcement behavior are tested, but the current record does not prove improved delivery success. A paired feature benchmark—same model, task, and budget—is the next evaluation. +Boatstack is an open-source research prototype. Its workflow and enforcement behavior are tested. But the current record does not prove improved delivery success. The next evaluation is a paired feature benchmark with the same model, task, and budget. Exact Intelligence Flow provenance and generated file hashes are recorded in [`UPSTREAM.json`](UPSTREAM.json). diff --git a/UPSTREAM.json b/UPSTREAM.json index 852f3ac..4fd7145 100644 --- a/UPSTREAM.json +++ b/UPSTREAM.json @@ -12,8 +12,8 @@ }, "files": { ".gitignore": "a7079e923a776f14f1bb3a6aa0a11a133a8e1dfb35af020f327623357b7e3957", - "CONTRIBUTING.md": "d036445ff05dfc40abb8a74d9bab61411474599a66c8e6678b72987e2ad9df2d", - "README.md": "6b7402c5cef5b3b9b739281d3d4d576cdc995796ff127fc6aefb97c5743e0bac", + "CONTRIBUTING.md": "a56c0ee373be7e3491996906937cbe779092c5709c80912f171d67e6a755a12a", + "README.md": "3ce3e95e511089b44e946a44b8d5f4f81d019ece5336db65b2cab1f9dc4d4dad", "assets/boatstack-journey.svg": "e465befc50c8ce30f3e07e8fd97012931beeb053392c8fbf38ad645023b3cc63", "assets/boatstack-mark.svg": "be1f984da1bfa69fa5d1f986d8343d21f7e20921b71db888c928b4d2e54b09b5", "assets/boatstack-portability.svg": "66dfdfa85db857b3bd18b32047a6975f1fbbfc4dc091158e8277193f9969a346", @@ -175,10 +175,10 @@ "docs/benchmark-corpus-audit.md": "f2d206fe8579a514f9da82b2c96c19b343ac004be67617e1bd34f0f8e0e5e6c6", "docs/benchmark-submission-audit.md": "9518abdd17690729c6423f87cab20418ed47b0915b5faa44b9ef975e9e9c3b79", "docs/configuration.md": "df054f49d532c8b1b7d94184810d1b3b5bf18cdc30eb985b4b6d0639162e341a", - "docs/evidence-engineered-coding.md": "f8abc34bc426482e0fa0f7e30fc0c5b6cdbfc03b25fdc81963b1e718e8736922", + "docs/evidence-engineered-coding.md": "1000dd25b8f56593390aaab82e2a83d1909c3bd573c0112162aa8be3d7b9807c", "docs/generated-files.md": "437791765b0a4015032ae21d1a6618563cad92b7402819e4f963bf5ae16284a3", "docs/getting-started.md": "1dd4f4e2e636cc5adfc2f79939629701e171087c3d5e558cf919548b9224adfd", - "docs/public-claims.json": "178cdeb2738ef09101e056591760ecf450666ad039931134987cb225512ffd81", + "docs/public-claims.json": "5dad07bb9c9b254ea8e0e917784dbd4a0de318bf00890fbbc5f902468c78c849", "docs/public-surface.md": "713f7a050b5f339cf948299103ef3800417dccfecf2cc1a4166397ea6f978907", "docs/research-and-design.md": "8d78678108f0a6c924e1ff9b32c0f81aae9d1f779e0082843b6f99ad993ae2b6", "docs/safety.md": "7b9b5c515d36e683767ec8d3d9d6d119ac93650b2f629d351deadd4c600ed6a6", @@ -192,7 +192,7 @@ "labs/diagram-json/compiled/evidence.md": "1ba1c989ade070a8ef9a508fbd788d100d7292f2dbacbb2bce895468019f619d", "labs/diagram-json/compiled/tasks.json": "88f60851abf79d851e9fccc754ff3040034ae595306bc87d64784c19eb403e71", "labs/diagram-json/compiled/test-matrix.json": "424657ff505768e50fa113801fd8363364a18269d5297480907a993d44063a39", - "labs/diagram-json/plan.lock.json": "f3e4094f2ac5731cf8774986c3e8233d1dbc843d5684efc9b2ab7ba245cea340", + "labs/diagram-json/plan.lock.json": "f1c1abc21dc10b530e05cd26055b4f329a95ea87e4552c2846c280e0aa2b2443", "labs/diagram-json/plan.md": "3cc4f533b8d69386deff16b3a594a3ba09d4c0c3db636cccd8c4380084ce6a51", "labs/diagram-json/questions.md": "74733b015002c8a6777c558e7e997fa48c94850b9bd39054fe9366c97ecf728d", "labs/diagram-json/request.md": "0808fc41c36779c404f4a3a121167da6e76cac56df526e70f9ed6d3e0d4c02ed", @@ -288,12 +288,13 @@ "release-notes/2026-07-25-deliverycontrol-shadow-registry.md": "e7f8ca4e4f188eda3088e46cba77369d8ff0d903f29e43846103d986e79a2273", "release-notes/2026-07-25-evidence-path-resolution.md": "b32cb8a6e69f397f751c3a7fb62be254a7407a28bed25ae9108d6d773c863d11", "release-notes/2026-07-25-published-slice-correction-routing.md": "129cdd62c80c8b93060726027d68ba3abdb0bca1a1ce9e64d6053271af3fd082", + "release-notes/2026-07-25-readme-simplified-technical-english.md": "c362f46702c38dda6b0301d05b95a067da617d170ddfcca22fd7eb9f6e2c1881", "release-notes/2026-07-25-root-cause-operation.md": "5bf1f082e9123c5a7bcc8bc01b12e97b24b5ae15958577b4ff2a358994fca891" }, "generator": "operatorstack/intelligence-flow:boatstack-distribution", "schema_version": 1, "source": { - "commit": "719220d52b8ac1237c9169099b53a024dc583cc6", + "commit": "dc521a60a4a3dc03405d545ca63feaa753087b54", "path": "labs/12-product-engineering-loop", "repository": "operatorstack/intelligence-flow" } diff --git a/docs/evidence-engineered-coding.md b/docs/evidence-engineered-coding.md index 7e3398b..4efd768 100644 --- a/docs/evidence-engineered-coding.md +++ b/docs/evidence-engineered-coding.md @@ -146,6 +146,6 @@ Delivery and system improvement also remain separate. A failed task may suggest ## What is evidence-backed -The current moves were derived from the Intelligence Flow benchmark corpus and product-repository studies. The generated source commit is [`719220d52b8ac1237c9169099b53a024dc583cc6`](https://github.com/operatorstack/intelligence-flow/tree/719220d52b8ac1237c9169099b53a024dc583cc6/labs/12-product-engineering-loop). +The current moves were derived from the Intelligence Flow benchmark corpus and product-repository studies. The generated source commit is [`dc521a60a4a3dc03405d545ca63feaa753087b54`](https://github.com/operatorstack/intelligence-flow/tree/dc521a60a4a3dc03405d545ca63feaa753087b54/labs/12-product-engineering-loop). The evidence supports specific failure mechanisms and guardrails. It does not establish that Boatstack is optimal, that control-theory notation proves software quality, or that one workflow dominates every team. Those are evaluation questions, so the distribution preserves measurements, provenance, gaps, and negative results. diff --git a/docs/public-claims.json b/docs/public-claims.json index 2fd36ae..d024dfe 100644 --- a/docs/public-claims.json +++ b/docs/public-claims.json @@ -1,6 +1,6 @@ { "schema_version": 1, - "source_commit": "719220d52b8ac1237c9169099b53a024dc583cc6", + "source_commit": "dc521a60a4a3dc03405d545ca63feaa753087b54", "statuses": ["verified", "observed", "still_being_evaluated"], "claims": [ { @@ -12,7 +12,7 @@ "readable_evidence": "why-these-steps.md#portable-workflow-and-state", "implementation": ["../boatstack/export.go", "../boatstack/references/artifacts.md", "../boatstack/references/workflow.md"], "verification": ["../boatstack/export_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "human-decisions", @@ -23,7 +23,7 @@ "readable_evidence": "why-these-steps.md#human-decisions", "implementation": ["../boatstack/references/workflow.md", "../boatstack/plan.go"], "verification": ["../boatstack/plan_test.go", "../boatstack/planning_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "validation-provenance", @@ -34,7 +34,7 @@ "readable_evidence": "why-these-steps.md#validation-provenance", "implementation": ["validation-and-evidence.md", "../boatstack/plan.go"], "verification": ["../boatstack/plan_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "irreversible-operations", @@ -46,7 +46,7 @@ "readable_evidence": "why-these-steps.md#irreversible-operations", "implementation": ["safety.md", "../boatstack/safety.go", "../boatstack/hooks.go"], "verification": ["../boatstack/safety_test.go", "../boatstack/hooks_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "reviewer-ready-pr", @@ -57,7 +57,7 @@ "readable_evidence": "why-these-steps.md#reviewer-ready-pr", "implementation": ["../boatstack/pr.go", "getting-started.md"], "verification": ["../boatstack/pr_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "phase-scoped-delivery", @@ -68,7 +68,7 @@ "readable_evidence": "why-these-steps.md#phase-scoped-delivery", "implementation": ["../boatstack/delivery.go", "../boatstack/safety.go", "../boatstack/hooks.go", "../boatstack/references/workflow.md"], "verification": ["../boatstack/delivery_test.go", "../boatstack/pr_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "model-neutral-contract", @@ -79,7 +79,7 @@ "readable_evidence": "why-these-steps.md#model-choice-and-budget", "implementation": ["research-and-design.md", "../boatstack/references/workflow.md"], "verification": ["../boatstack/export_test.go", "../boatstack/planning_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "cross-model-failures", @@ -90,7 +90,7 @@ "readable_evidence": "why-these-steps.md#model-choice-and-budget", "implementation": ["research-and-design.md"], "verification": ["benchmark-corpus-audit.md", "benchmark-submission-audit.md"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "lower-cost-outcomes", @@ -101,7 +101,7 @@ "readable_evidence": "why-these-steps.md#model-choice-and-budget", "implementation": ["research-and-design.md"], "verification": ["benchmark-corpus-audit.md", "benchmark-submission-audit.md"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "git-worktree-activation", @@ -112,7 +112,7 @@ "readable_evidence": "why-these-steps.md#git-worktree-activation", "implementation": ["../boatstack/runtime_cache.go", "../boatstack/hooks.go"], "verification": ["../boatstack/runtime_cache_test.go", "../boatstack/hooks_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" }, { "id": "visible-updates", @@ -123,7 +123,7 @@ "readable_evidence": "why-these-steps.md#visible-updates", "implementation": ["../boatstack/update.go", "../boatstack/init.go"], "verification": ["../boatstack/update_test.go", "../boatstack/init_test.go", "../boatstack/export_test.go"], - "last_verified_version": "source:719220d52b8ac1237c9169099b53a024dc583cc6" + "last_verified_version": "source:dc521a60a4a3dc03405d545ca63feaa753087b54" } ] } diff --git a/labs/diagram-json/plan.lock.json b/labs/diagram-json/plan.lock.json index c7bf546..c798ebe 100644 --- a/labs/diagram-json/plan.lock.json +++ b/labs/diagram-json/plan.lock.json @@ -6,7 +6,7 @@ "plan_path": "labs/diagram-json/plan.md", "plan_sha256": "3cc4f533b8d69386deff16b3a594a3ba09d4c0c3db636cccd8c4380084ce6a51", "schema_version": 1, - "source_commit": "719220d52b8ac1237c9169099b53a024dc583cc6", + "source_commit": "dc521a60a4a3dc03405d545ca63feaa753087b54", "source_plan_path": "labs/diagram-json/source-plan.md", "source_plan_sha256": "e10593ddaa7522ab80cc991d0a09399257139799e37f737794cd49d68a39985b", "spec_path": "labs/diagram-json/spec.md", diff --git a/release-notes/2026-07-25-readme-simplified-technical-english.md b/release-notes/2026-07-25-readme-simplified-technical-english.md new file mode 100644 index 0000000..0e29553 --- /dev/null +++ b/release-notes/2026-07-25-readme-simplified-technical-english.md @@ -0,0 +1,17 @@ +### The public README follows Simplified Technical English + +The distribution `README.md` is the first page most readers and models see, and it is +increasingly translated and summarized by tools. To make it clearer and easier to +translate, it now follows the house rules in `simplified-technical-english.md` +(our paraphrase of the ASD-STE100 controlled-language standard). + +The rewrite is editorial, not a change of claims. Every `boatstack-claim` marker, the +verified/observed/being-evaluated hedges, the tables, the diagrams and their alt text, +the code blocks, and every link stay exactly as before. Only the prose changed. + +The prose now prefers short sentences, the active voice, and the present tense. It states +one instruction per sentence, puts the condition first, and uses the simple common word. +For example, "utilization prior to transport" becomes "encode it before you transport it", +and passive descriptions such as "an open PR is updated after fresh gates" become active +ones such as "Boatstack updates an open PR after fresh gates". The meaning, scope, and +evidence status of each statement are unchanged.