Skip to content

docs: add Echo v0.1.0 release plan#369

Merged
flyingrobots merged 6 commits into
mainfrom
stack/docs-bearing-next-slices
May 22, 2026
Merged

docs: add Echo v0.1.0 release plan#369
flyingrobots merged 6 commits into
mainfrom
stack/docs-bearing-next-slices

Conversation

@flyingrobots
Copy link
Copy Markdown
Owner

@flyingrobots flyingrobots commented May 22, 2026

Summary

  • Add a dedicated Echo v0.1.0 release plan defining the local deterministic contract-host release bar.
  • Update BEARING and contract-hosting backlog sequencing to reflect the next five slices and semantic-retention wording.
  • Add authority bar, release gate matrix, do-not-regress guardrails, versioned compatibility requirements, and release candidate criteria.

Validation

  • git diff --check
  • pnpm exec markdownlint-cli2 docs/design/v0.1.0-release-plan.md docs/BEARING.md docs/method/backlog/asap/PLATFORM_contract-hosted-file-history-substrate.md docs/method/backlog/asap/PLATFORM_echo-contract-hosting-roadmap.md docs/method/backlog/up-next/PLATFORM_contract-retention-and-streaming-seams.md
  • cargo xtask lint-dead-refs --file docs/design/v0.1.0-release-plan.md --file docs/BEARING.md --file docs/method/backlog/asap/PLATFORM_contract-hosted-file-history-substrate.md --file docs/method/backlog/asap/PLATFORM_echo-contract-hosting-roadmap.md --file docs/method/backlog/up-next/PLATFORM_contract-retention-and-streaming-seams.md

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced v0.1.0 release milestone lane to organize blocker items and release requirements.
    • Added comprehensive v0.1.0 release plan with feature clusters, release gates, and validation checklist.
  • Documentation

    • Created eight new v0.1.0 release-blocker specifications covering contract hosting, proof fixtures, and authority boundaries.
    • Updated roadmap with five-slice delivery plan and release candidate criteria.
    • Added release-grade quickstart guide and product-facing API definitions.
  • Improvements

    • Enhanced markdown link generation for improved documentation navigation.
    • Updated backlog lane organization and status tracking.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 93a7e8e0-9c32-41cb-8043-f6ad296e4eb3

📥 Commits

Reviewing files that changed from the base of the PR and between 1d4a22d and 4caacce.

⛔ Files ignored due to path filters (3)
  • docs/method/task-dag.dot is excluded by !**/*.dot
  • docs/method/task-dag.svg is excluded by !**/*.svg
  • docs/method/task-matrix.csv is excluded by !**/*.csv
📒 Files selected for processing (34)
  • METHOD.md
  • crates/method/src/graph.rs
  • crates/method/src/workspace.rs
  • crates/method/tests/graph_tests.rs
  • crates/method/tests/status_tests.rs
  • docs/BEARING.md
  • docs/design/v0.1.0-release-plan.md
  • docs/index.md
  • docs/method/backlog/asap/PLATFORM_contract-hosted-file-history-substrate.md
  • docs/method/backlog/asap/PLATFORM_contract-queryview-observer-bridge.md
  • docs/method/backlog/asap/PLATFORM_echo-contract-hosting-roadmap.md
  • docs/method/backlog/cool-ideas/PLATFORM_proof-carrying-apertures.md
  • docs/method/backlog/up-next/KERNEL_contract-inverse-admission-hook.md
  • docs/method/backlog/up-next/PLATFORM_authenticated-wesley-intent-admission-posture.md
  • docs/method/backlog/up-next/PLATFORM_contract-retention-and-streaming-seams.md
  • docs/method/backlog/up-next/PLATFORM_jedit-contract-proof-fixture.md
  • docs/method/backlog/up-next/PLATFORM_jedit-text-contract-mvp.md
  • docs/method/backlog/up-next/PLATFORM_wesley-footprint-honesty-artifact-attestation.md
  • docs/method/backlog/v0.1.0/DOCS_release-grade-quickstart.md
  • docs/method/backlog/v0.1.0/KERNEL_contract-aware-receipts-and-readings.md
  • docs/method/backlog/v0.1.0/KERNEL_contract-obstruction-taxonomy.md
  • docs/method/backlog/v0.1.0/KERNEL_contract-reading-identity-and-bounded-payloads.md
  • docs/method/backlog/v0.1.0/KERNEL_witnessed-intent-submission-persistence.md
  • docs/method/backlog/v0.1.0/PLATFORM_app-safe-client-surface.md
  • docs/method/backlog/v0.1.0/PLATFORM_contract-artifact-retention-in-echo-cas.md
  • docs/method/backlog/v0.1.0/PLATFORM_contract-retention-and-semantic-lookup-seams.md
  • docs/method/backlog/v0.1.0/PLATFORM_external-contract-proof-fixture.md
  • docs/method/backlog/v0.1.0/PLATFORM_product-facing-intent-outcome-api.md
  • docs/method/backlog/v0.1.0/PLATFORM_reference-trusted-runtime-host-loop.md
  • docs/method/backlog/v0.1.0/PLATFORM_versioned-contract-api-compatibility.md
  • docs/method/backlog/v0.1.0/RELEASE_v0.1.0-release-candidate.md
  • docs/method/backlog/v0.1.0/SECURITY_authority-boundary-audit.md
  • docs/method/backlog/v0.1.0/TEST_v0.1.0-replay-dind-proof.md
  • docs/method/task-matrix.md
💤 Files with no reviewable changes (2)
  • docs/method/backlog/up-next/PLATFORM_jedit-contract-proof-fixture.md
  • docs/method/backlog/up-next/PLATFORM_contract-retention-and-streaming-seams.md

📝 Walkthrough

Walkthrough

This PR introduces v0.1.0 as a release backlog lane across the Echo method infrastructure and establishes comprehensive release planning documentation. The changes wire the lane into code constants, fix markdown link rendering to use versioned paths, and add 16 specification documents covering eight required feature clusters with detailed acceptance criteria, dependencies, and constraints.

Changes

v0.1.0 Release Bar Infrastructure and Planning

Layer / File(s) Summary
v0.1.0 Backlog Lane Infrastructure
METHOD.md, crates/method/src/graph.rs, crates/method/src/workspace.rs, crates/method/tests/graph_tests.rs, crates/method/tests/status_tests.rs
v0.1.0 lane is added to GRAPH_LANES, LANES, and lane color mappings; lane ordering semantics clarified in METHOD.md; test scaffolding updated to include the new lane.
Markdown Link Rendering and Relative Path Generation
crates/method/src/graph.rs, crates/method/tests/graph_tests.rs
New method_docs_relative_link_target helper generates task links relative to docs/method/backlog/ root; render_matrix_markdown and task_markdown_link updated to use versioned paths with optional anchor handling; test validates link generation and v0.1.0 lane frontier ordering.
v0.1.0 Release Plan Specification
docs/design/v0.1.0-release-plan.md
Comprehensive 568-line specification defining scope, authority boundaries, implementation baseline status across 11 subsystems, eight required feature clusters, feature checklist, non-goals, release gate matrix tied to witnesses/tests, developer happy path workflow, release themes, likely roadmap, and release candidacy criteria.
Feature Cluster Specification Documents
docs/method/backlog/v0.1.0/KERNEL_*.md, docs/method/backlog/v0.1.0/PLATFORM_*.md, docs/method/backlog/v0.1.0/SECURITY_*.md, docs/method/backlog/v0.1.0/TEST_*.md, docs/method/backlog/v0.1.0/DOCS_*.md, docs/method/backlog/v0.1.0/RELEASE_*.md
16 specification documents covering contract-aware receipts/readings identity, obstruction taxonomy, retention and semantic lookup seams, witnessed submission persistence with recovery constraints, app-safe client surface, versioned contract/API compatibility, trusted runtime host loop, external consumer proof fixture, release-grade quickstart, replay/DIND proof, and release-candidate criteria.
Backlog Cross-references and Documentation Updates
docs/method/backlog/asap/PLATFORM_*.md, docs/method/backlog/cool-ideas/PLATFORM_*.md, docs/method/backlog/up-next/PLATFORM_*.md, docs/method/backlog/up-next/KERNEL_*.md
Existing backlog items retarget dependencies from up-next/ and local relative paths to v0.1.0/ lane specs; sequence checklists reordered; dependency links updated for contract-aware receipts, retention, artifact specs, and identity docs.
Project Direction and Navigation Updates
docs/BEARING.md, docs/index.md
Current Bearing redefined to focus on v0.1.0 release-bar and consumer-grade witnessed-intent pipeline; "What Is Not Yet True" and roadmap sections rewritten to reflect durable restart-proof ingress, client ABI helpers, contract-aware identity evidence, semantic lookup retention, and external proof fixtures; "Next Five Slices" introduced; v0.1.0 release plan link added to "Start Here" section.

Sequence Diagram(s)

Sequence diagram generation conditions not met. The changes are primarily documentation and infrastructure wiring rather than new functional flows with multi-component interactions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Most changes are documentation additions and lane constant/infrastructure updates. Code changes are localized to graph rendering (relative link generation helper) and lane wiring. The 16 specification documents follow consistent structure and cross-reference patterns. Homogeneous documentation patterns with repetitive structure reduce review cognitive load despite volume.

Possibly related issues

  • #370: Main changes implement the v0.1.0 release-bar lane and associated release planning infrastructure tracked by this issue.

Suggested labels

tooling, documentation

Poem

🎯 A milestone lane emerges bright,
Eight feature clusters set in sight,
Relative links now render true,
v0.1.0 — the path shines through.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add Echo v0.1.0 release plan' accurately describes the primary change: a new release plan document defining v0.1.0 scope, gates, and blockers.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch stack/docs-bearing-next-slices

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@flyingrobots
Copy link
Copy Markdown
Owner Author

Added the v0.1.0 backlog lane in a186ad2.

  • Created docs/method/backlog/v0.1.0/ as the filesystem lane for release-bar blockers.
  • Moved the current release blockers out of up-next/ into the lane.
  • Added release-gate cards for obstruction taxonomy, product intent outcomes, trusted host loop, app-safe client surface, version compatibility, replay/DIND proof, quickstart, authority audit, and release candidate.
  • Made v0.1.0 a first-class METHOD graph lane and regenerated matrix/DAG artifacts.

Validation: cargo test -p method, cargo xtask method check-dag, markdownlint, authored-doc dead-ref lint, git diff --check, and pre-push narrow slice passed.

@flyingrobots
Copy link
Copy Markdown
Owner Author

@codex Self-review found issues that should be resolved before merging PR #369.

Severity File / lines Issue Evidence Recommended mitigation
P1 crates/method/src/workspace.rs:8-9, crates/method/src/status.rs:44-50 v0.1.0/ is not registered in the METHOD workspace lane list, so cargo xtask method status silently omits the new release lane. This PR adds the lane to METHOD.md and crates/method/src/graph.rs, but workspace::LANES remains ['inbox', 'asap', 'up-next', 'cool-ideas', 'bad-code']. Running cargo xtask method status reports asap, bad-code, cool-ideas, inbox, and up-next, but no v0.1.0, despite 15 v0.1.0 cards in the matrix. Add v0.1.0 to the shared METHOD lane source used by status/discovery, or consolidate graph/status lane definitions so the lane cannot drift. Add/update a status test proving v0.1.0 is counted.
P2 crates/method/src/graph.rs:14-21, crates/method/src/graph.rs:326-328, METHOD.md:38-39 The milestone lane is sorted as a priority lane in method frontier, contradicting the new doctrine that it is not an automatic priority override. GRAPH_LANES ranks v0.1.0 between asap and up-next, and frontier.sort_by(...) uses lane_rank. Running cargo xtask method frontier lists v0.1.0 cards immediately after asap, before up-next, even though METHOD.md says release-blocking cards move to asap only when they become the current pull. Either rank v0.1.0 after up-next, or split display lanes from scheduling lanes and make frontier exclude/deprioritize milestone lanes unless promoted to asap. Add a frontier-order regression test.
P2 docs/method/backlog/v0.1.0/PLATFORM_contract-retention-and-semantic-lookup-seams.md:16, docs/method/backlog/v0.1.0/PLATFORM_contract-retention-and-semantic-lookup-seams.md:38-44 The v0.1.0 retention card imports inverse/unapply/wormhole requirements into the release bar. The card is now a v0.1.0 release blocker, but its acceptance criteria require TickReceipt inverse resolution, unapply obstruction, inverse edit safety, and wormhole/checkpoint unapply behavior. That conflicts with the release-plan intent to keep v0.1.0 to local contract hosting and leaves inverse/counterfactual work outside the first release. Split the card: keep v0.1.0 scoped to semantic retention/lookup for artifacts, receipts, readings, and bounded payloads; move inverse/unapply/wormhole criteria to the inverse admission or post-v0.1 file-history cards.
P4 docs/method/task-matrix.md:46-60, crates/method/src/graph.rs:451-455, crates/method/src/graph.rs:1188-1194 Generated task-matrix links for the new v0.1.0 cards are dead relative links from docs/method/task-matrix.md. The matrix emits links like docs/method/backlog/v0.1.0/DOCS_release-grade-quickstart.md inside docs/method/task-matrix.md; relative resolution points to docs/method/docs/method/.... cargo xtask lint-dead-refs --file docs/method/task-matrix.md reports broken links. This predates the PR for older rows, but this PR adds the same broken pattern for new v0.1.0 rows while touching the generator. Update the matrix renderer to emit links relative to docs/method/task-matrix.md (for example backlog/v0.1.0/...) or root-absolute docs links, then regenerate matrix/DAG artifacts. Add a small renderer test for a generated matrix link target.

Validation notes from review: git diff --check, cargo xtask method check-dag, cargo test -p method --lib graph::tests, markdownlint on changed Markdown, and authored-doc dead-ref lint all pass. The issues above are semantic/tooling drift, not formatting failures.

@chatgpt-codex-connector
Copy link
Copy Markdown

Summary

Testing

  • cargo test -p method --lib graph::tests status::tests (invalid cargo args; corrected by running as separate commands)
  • cargo test -p method --lib graph::tests
  • cargo test -p method --lib status::tests
  • cargo xtask method matrix
  • ⚠️ cargo xtask method dag (fails in this environment because Graphviz dot is not installed)
  • ⚠️ cargo xtask method check-dag (matrix reported current; command still fails due to missing Graphviz dot binary)

View task →

@flyingrobots
Copy link
Copy Markdown
Owner Author

Self-review issues resolved in 4caacce.

Severity Issue Resolution Witness
P1 v0.1.0/ was missing from METHOD status/workspace lane accounting. Added v0.1.0 to workspace::LANES; cargo xtask method status now reports v0.1.0: 15. cargo test -p method --test status_tests status_counts_lane_files
P2 method frontier ranked v0.1.0 ahead of up-next, contradicting milestone-lane doctrine. Reordered graph scheduling lanes so up-next remains ahead of milestone release-bar cards unless promoted to asap. cargo test -p method --test graph_tests milestone_lane_does_not_preempt_up_next_frontier_order
P2 v0.1.0 retention card pulled inverse/unapply/wormhole work into the release bar. Scoped the v0.1.0 card to semantic retention/lookup for artifacts, receipts, witnesses, readings, and bounded payloads; moved inverse retention requirements to the post-v0.1 inverse admission card. Markdown review + pnpm exec markdownlint-cli2 ...
P4 Generated task-matrix links for new rows were dead relative to docs/method/task-matrix.md. Matrix renderer now emits method-doc-relative targets like backlog/v0.1.0/...; regenerated matrix/DAG artifacts. cargo test -p method --test graph_tests matrix_markdown_links_are_relative_to_method_docs_root; cargo xtask lint-dead-refs --file docs/method/task-matrix.md

Validation also passed: cargo test -p method, cargo fmt --check, git diff --check, cargo xtask method check-dag, markdownlint, dead-ref lint, and pre-push exact method slices.

@flyingrobots flyingrobots merged commit 1d29edd into main May 22, 2026
36 checks passed
@flyingrobots flyingrobots deleted the stack/docs-bearing-next-slices branch May 22, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant