Skip to content

docs: consolidate contract registry into spec/ + unify plans under docs/plan/#173

Merged
hanwencheng merged 1 commit into
mainfrom
claude/great-elgamal-63ab86
Jun 2, 2026
Merged

docs: consolidate contract registry into spec/ + unify plans under docs/plan/#173
hanwencheng merged 1 commit into
mainfrom
claude/great-elgamal-63ab86

Conversation

@hanwencheng
Copy link
Copy Markdown
Member

What & why

Two related docs reorganizations requested by the operator.

1. Single canonical contract registry under docs/spec/

#171 had split the contract registry into a new top-level docs/contracts.md plus a docs/spec/deployed-contracts.md redirect stub. This re-unifies them:

2. Unify plans under docs/plan/ (removed docs/spec/plans/)

Assessed every plan for outdated-ness, then consolidated:

  • Active → docs/plan/: milestones-roadmap + execution-plan (canonical, referenced from arch.md/CLAUDE.md), ceo-plan, issue-103, issue-107-mcp-demo-runbook, issue-74-step-1c, issue-82-erc7730, issue-credential-storage-s3-oidc, phase-1-wire-onboarding, phase1-wire-harness-test-plan, v2-issues/.
  • Shipped/outdated → docs/archived/: issue-64/, issue-107-mcp-server-phase1, issue-144, issue-74-dev-key-service, agent-initiated-pairing-method-a, design-spec, eng-review-test-plan.
  • All 32 moves via git mv (history preserved); docs/plan/README.md index rewritten.

Reviewer notes

  • ~50 references rewritten across docs, wiki, Rust doc-comments, Cargo.toml, harness/scripts, pm/, README — including relative plans/X.md links inside docs/spec/ and a full depth-correction pass (moving files up one dir level broke every ../ up-link; 106 links fixed semantically by resolving against the repo tree).
  • Code changes are comment / doc-string only — no logic touched (verified: the only .rs/.toml edits are //!, ///, #, and one doc-URL string constant).
  • Verification: a broken-link scan confirms zero broken links to any moved or contract file; the new contracts doc's 10 internal links all resolve.

Deferred (out of scope)

  • ~30 links to development-stages.md are broken, but were already broken before this PR (that file was archived in a prior PR). Tracked separately.
  • Moved-to-archived files' own internal cross-links are now stale from the depth shift — left frozen per the docs/archived/ "never read in normal dev" policy.

🤖 Generated with Claude Code

…cs/plan/

Contracts: merge docs/contracts.md (#171 superset) and the spec/ deployed-contracts redirect into a single canonical docs/spec/deployed-contracts.md; restore the ABI-summary + re-deploy sections #171 trimmed; add an explicit prod-vs-test EVM deployer-wallet table (local 0xdE64..63Bc, test/CI 0x9FE9..F259). docs/contracts.md is now a redirect. Repoint arch.md §5 + CLAUDE.md + operator-runbook-wire + the erc4337 plan.

Plans: remove docs/spec/plans/. Active plans -> docs/plan/ (incl. the canonical milestones-roadmap + execution-plan); shipped/outdated -> docs/archived/ (issue-64/, issue-107-mcp-server-phase1, issue-144, issue-74-dev-key-service, agent-initiated-pairing-method-a, design-spec, eng-review-test-plan). Rewrite ~50 references repo-wide (docs, wiki, Rust doc-comments, Cargo.toml, harness/scripts, pm/, README) and depth-correct relative links in moved files. Rewrite docs/plan/README.md index.

Verified: broken-link scan shows zero broken links to any moved/contract file; code changes are comment/doc-string only (no logic touched).
@hanwencheng hanwencheng merged commit 978f723 into main Jun 2, 2026
9 checks passed
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