Repository navigation
docs: add the public repository README - #28
Merged
Merged
Conversation
The repository had no root README. plan.md section 5b lists one as an Arc qualification artifact, owned by lane A, carrying the architecture diagram, and the Gate P6 checklist verifies it exists. Written for someone arriving at the public repository, not for the team: it opens with the concrete failure OneShot exists to prevent, an agent that cannot tell a lost response from a lost payment, rather than with the milestone plan. The delivery plan stays in plan.md and milestones/, linked rather than duplicated. Contains the architecture diagram and the durable state machine as Mermaid, which the Markdown and Mermaid CI job renders. Solid edges mark what is implemented and dashed edges what is planned, so the diagram is not read as a claim that the Subgraph MCP and recovery agent paths exist. The status section is deliberately conservative. It states that no live settlement has been executed, that no Privy application, wallet, policy, or funded account has been provisioned, that the adapters are proven against simulators and therefore demonstrate the logic and not the providers' behaviour, and that the Privy and Arc integrations are NOT VERIFIED. The sponsor-qualification skill forbids a claim resting on fixtures alone, and a public README is exactly where such a claim would do damage. Every documented command was run before being listed. The API table was completed after checking the routes actually registered in apps/api, which turned up the recovery-view and metrics endpoints missing from the first draft.
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
oneshot | b6e4609 | Sep 07 2026, 10:22 PM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the root
README.md. The repository had none.plan.mdsection 5b lists it as an Arc qualification artifact — the row"Architecture diagram | Diagrams exported from this plan into the public
repository README" — and the Gate P6 checklist verifies it exists. So this is a
submission requirement, not just polish.
Written for someone arriving at the public repository, not for the team. It
opens with the concrete failure OneShot prevents (an agent that cannot tell a
lost response from a lost payment), then the architecture, the invariants, and
how to run it. The delivery plan stays in
plan.mdandmilestones/, linkedrather than duplicated.
Scope and acceptance criteria
One new file. Nothing else touched.
Markdown and MermaidCI job.diagram cannot be read as claiming the Subgraph MCP adapter and recovery
agent exist. They do not.
milestones/CONTRACTS.mdsection 6.
Product and security invariants
Invariant notes:
Documentation only; no code, schema, or configuration changes, so the isolation
and sponsor-control rows are not applicable.
The invariant that does apply here is the sponsor-qualification rule: no claim
may rest on fixtures alone. A public README is exactly where such a claim would
do damage, so the status section states plainly that no live settlement has
been executed, that no Privy application, wallet, policy, or funded account
has been provisioned, that the adapters are proven against simulators and
therefore demonstrate the logic and not the providers' behaviour, and that the
Privy and Arc integrations are
NOT VERIFIED. It does not contradictdocs/settlement/LIVE_EVIDENCE.md.It also records that Arc Mainnet is unconfigured and its profile deliberately
carries no chain ID, RPC, explorer, or token value.
Validation
Every documented command, path, and endpoint was run or checked before being
listed:
Checking the routes actually registered in
apps/api/src/app.tsturned up therecovery-viewandmetricsendpoints missing from my first draft; the APItable now matches the code.
Independent review evidence
Gate A — exact candidate tree before push
feature/root-readme @ b6e4609free-pi-cli0.2.19glm-5.3-flashREADME_PASS)The reviewer was asked to judge it hard on accuracy, and specifically to verify
against the repository that the endpoints match the registered routes, the
layout matches the packages that exist, the quick-start commands match the root
scripts and declared Node/pnpm versions, the probe script exists as documented,
the solid-versus-dashed claim is truthful, the state machine matches
CONTRACTS.mdsection 6, and the status section makes no sponsor claim restingon fixtures.
Evidence caveat: the literal
VERDICT:line was lost to terminal viewporttruncation. Captured evidence is
REVIEWED_TARGET: feature/root-readme @ b6e4609, an empty blocking-findings section, and the terminalREADME_PASStoken.
Risk and rollback
solid-vs-dashed diagram will need updating as the recovery agent and frontend
land, and as live evidence replaces
LIVE_NOT_RUN.plan.mdassigns the README to lane A. It is written here because lane B isparked waiting on Gate P4, and it is a submission requirement that was
missing.
Rollback: delete the file. Nothing references it.
Human merge