id: "GW20-023"
title: "Correct public Runtime guides and add a direct-builder quick start"
type: "feature"
status: "planned"
milestone: "v20.1.0"
category: "required"
workstream: "docs"
issue: "#979"
baseline_commit: "ceb58e656ec5bc85f0ae5991bf2a55599693bbb3"
feedback_sections: [5, 10, 12, 13, 15, 16, 18]
prerequisites: []

Feature

LLM prompt

Complete GW20-023: Correct public Runtime guides and add a direct-builder quick start.
Read this entire task and its current GitHub issue before implementation.
Verify the current mainline and all prerequisite integrations.
Read AGENTS.md and the three TypeScript policy documents.
Use runtime-backed domain values and injected ports.
Keep parsing and codecs at the adapter boundary.
Preserve v20 APIs, stored identities, CRDT semantics, and failure meanings.
Use one coherent issue, PR, and mainline integration. Do not leave a broken intermediate state.
Problem to resolve:
Current pages mix internal APIs with public Runtime examples. Some signatures, subpaths, limits, and cost statements do not match v20.0.0.
Acceptance checks:
Use Runtime at the root and list actual package subpaths. Remove public openWarp and storage examples.
Replace the Lane.observer aperture example with supported public Observer construction. Label internal aperture limitations explicitly.
Use previewSettlement({ source, target }). Document supported strand sources, coordinates, author evidence, and common-basis limits.
Add a complete direct-builder quick start through advanced. Keep Wesley generation optional and explain its role.
State current checkpoint policy, tail limits, coordinate retention, slice support, and measured cost posture accurately.
Replace retired graph.query.worldline and docs/READINGS_AND_OPTICS.md recovery references with supported APIs and current pages.
State the tested runtime matrix. Distinguish reported Bun success from maintained Bun support.
Read these source paths:
README.md
docs/topics/observers.md
docs/topics/strands.md
docs/topics/git-substrate.md
docs/topics/getting-started.md
docs/topics/optic-reads.md
src/domain/services/controllers/QueryStateMessages.ts
Prerequisites: None established. Recheck external readiness.
Scope exclusions: Claim future roadmap features as shipped, restore retired APIs, or require undocumented private imports.
Run all tests and benchmarks in COPY-based Docker without host repository mounts.
Use the project guarded runner and the shared git-locks authority.
Lock host/heavy-work and the exact worker key together for expensive work.
Limit build caches to 20 GiB, test data to 4 GiB, and logs to 128 MiB.
Require 50 GiB free on host and Docker backing storage before heavy work.
Enforce disk accounting, CPU, memory, timeout, and child-process shutdown.
Do not start an unguarded workload. Do not bypass a resource refusal.
Require full touched-code coverage for refactors and an all-green manual SSJS scorecard.
Record source, image, command, fixtures, results, limits, and the regression witness.
Commit only your own files. Do not amend, rebase, force, push, or publish without authorization.
Report incomplete or blocked checks. Do not claim completion from a narrow green test.
Link the issue, coherent PR, and actual mainline integration when those actions are authorized.

1. Background Context

Source: FEEDBACK-git-warp.md, sections 5, 10, 12, 13, 15, 16, 18.
The report SHA-256 is 9b15209d51cd705059a9e6bfebf0f6681ff832924c1462b99ff3cfebde6bacae.
The report uses npm git-warp 20.0.0 and git-cas 6.5.11.
Its runtime results come from macOS host experiments. This planning task did not rerun them.
Source review baseline: ceb58e65.

Tracker: #979.

Read these source and test surfaces before work:

• README.md
• docs/topics/observers.md
• docs/topics/strands.md
• docs/topics/git-substrate.md
• docs/topics/getting-started.md
• docs/topics/optic-reads.md
• src/domain/services/controllers/QueryStateMessages.ts

2. Problem Description

Current pages mix internal APIs with public Runtime examples. Some signatures, subpaths, limits, and cost statements do not match v20.0.0.

2b. Proposed Solution

Correct current source-backed examples now. Each feature PR owns its changed API documentation. Recheck the guide against the final release candidate.

2c. Alternatives considered and rejected

Reject a private-import workaround. It does not provide a supported application contract.
Reject a documentation-only substitute when this task requires runtime behavior.
Keep larger storage and package redesigns under their existing issues.

2d. Acceptance Criteria

• Use Runtime at the root and list actual package subpaths. Remove public openWarp and storage examples.
• Replace the Lane.observer aperture example with supported public Observer construction. Label internal aperture limitations explicitly.
• Use previewSettlement({ source, target }). Document supported strand sources, coordinates, author evidence, and common-basis limits.
• Add a complete direct-builder quick start through advanced. Keep Wesley generation optional and explain its role.
• State current checkpoint policy, tail limits, coordinate retention, slice support, and measured cost posture accurately.
• Replace retired graph.query.worldline and docs/READINGS_AND_OPTICS.md recovery references with supported APIs and current pages.
• State the tested runtime matrix. Distinguish reported Bun success from maintained Bun support.

2e. Test Plan

Golden: Compile and execute each changed application example against the packed package in COPY-based Docker. Check generated references and local links.

Edges: No Wesley installation; fresh Runtime; obstruction; restart; structured values; missing basis; supported exports.

Known failure modes: preserve typed refusal, atomic publication, and complete evidence. Do not conceal unavailable support.

Fuzz and stress: use fixed fixture sizes and seeds. Apply the roadmap resource guards. Do not start an unbounded campaign.

3. Prerequisites

None established as an internal issue dependency. Verify the current boundary and external readiness before activation.

4. Scope

In: Current pages mix internal APIs with public Runtime examples. Some signatures, subpaths, limits, and cost statements do not match v20.0.0.

Out: Claim future roadmap features as shipped, restore retired APIs, or require undocumented private imports.

Safe intermediate state: one independently mergeable PR passes its relevant checks after its prerequisites.
Existing supported applications remain usable. Historical data remains intact.

5. Why now

This flaw blocks a supported Synapse store workflow or gives its operator incorrect guidance.
Resolve it within v20.1.0 without reducing the existing causal-history commitment.

6. Risks

Source inspection does not establish runtime or performance results.
Preserve historical identities, validation, and evidence. Do not weaken refusal to obtain a green result.
If the fix requires a breaking contract, record the conflict before activation. Do not hide it within a minor release.

7. Definition of Done

All acceptance checks have evidence from the exact candidate.
Relevant lint, typecheck, compatibility, and Docker checks pass.
The manual SSJS scorecard is green. Refactor coverage reaches 100% on touched code.
Record the issue, PR, and mainline integration commit. Record any external release gate.
A required check with missing evidence remains incomplete.

8. Stakeholders

James Ross: git-warp maintainer and acceptance owner.
Synapse store authors: applications need correct writes, reads, history, and operational guidance.
Library and CLI consumers: existing v20 contracts must remain usable.

9. Related Issues

• #392
• #904
• #955