Skip to content

Reconcile documentation authority and simplify onboarding - #42

Merged
snarkipus merged 1 commit into
mainfrom
docs/reconcile-documentation
Nov 9, 2026
Merged

snarkipus merged 1 commit into
mainfrom
docs/reconcile-documentation

Conversation

@snarkipus

Copy link
Copy Markdown
Owner

Summary

Owner-reviewed documentation-only cleanup authored by Claude Opus5.5 and checked by Hermes. No runtime, package version, release or operator-activation change.

  • Reduce README from 3,845 to 840 words; put detailed usage/configuration in one focused user guide.
  • Add a concise documentation index and clarify AGENTS.md: OpenSpec owns intended behavior; SDK references record upstream facts; historical reviews preserve evidence; Beads owns live execution status. Facts and evidence must not be rewritten to manufacture agreement with a spec.
  • Replace the sprawling SDK contract with a current integration reference mapping APIs/source to existing normative requirements. Preserve its original ledger in a clearly historical document, with mechanically rebased links and compatibility anchors for incoming references.
  • Preserve all original review reports, archived changes, runtime, packaged guidance and generated agent-integration blocks byte-for-byte.
  • Remove stale unexecuted Purpose prose and replace the obsolete unreleased-adaptation phase label with current 2.2 integration wording. No behavioral guarantee or scenario identity changes.
  • Relocate documentation assertions to the owning pages and check Markdown link anchors.

Verification

  • 220 tests / 12,058 assertions pass, including docs and link/anchor checks.
  • Typecheck, package smoke/load and strict canonical specs 3/3 passed; staged whitespace check passed.
  • Exact ten-file candidate matches the owner-reviewed attachment bundle.
  • Historical ledger body preserves the original except relative-link rebasing.

Authority

Authorized: commit, push this branch and open this PR. Merge is NOT yet authorized. No npm release, tag changes, runtime activation or Zeus changes. Published 2.0.0 remains immutable; these source README changes were not in that artifact.

Tracker: opencode-beads-dif (local cleanup accepted/closed; source-publication follow-through recorded on the same task).

@snarkipus
snarkipus merged commit bb496c1 into main Nov 9, 2026
3 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