Skip to content

docs: refresh repository documentation, crate READMEs, and LeanSpec alignment - #9

Merged
todie merged 1 commit into
developmentfrom
docs/repository-documentation-refresh
Oct 12, 2026
Merged

todie merged 1 commit into
developmentfrom
docs/repository-documentation-refresh

Conversation

@todie

@todie todie commented Oct 12, 2026

Copy link
Copy Markdown
Member

Summary

This pull request updates all repository documentation across unsigned-gg/ep in response to advice received from the research lane (session-agy-ceres-estate-w2a-p1 / alrisha in cerebral-work/research):

  1. Crate READMEs: Created structured README files for all five workspace crates (ep, ep-domain, escapement-core, escapement-serve, and blackwall-bridge) with metadata attribute tables, architectural layering, verification instructions (-j 2), and license declarations.
  2. Root Documentation: Updated README.md and ROADMAP.md with Crate Responsibility Matrix, Zero-I/O Domain Isolation rules, host throttling requirements (-j 2), and tri-license declarations (Apache-2.0 OR MIT OR CC0-1.0).
  3. Formal Specifications: Converted SPEC-0001 and SPEC-0002 to canonical LeanSpec format with formal YAML frontmatter, standard sections (Requirements, Design, Tasks, Verification, Notes), embedded Lean 4 proof blocks, and authentic Git source locators.
  4. LeanSpec Registry: Updated specs/README.md with tabular index of all specifications and primary source locators.
  5. Changelog: Initialized CHANGELOG.md following the Keep a Changelog 1.1.0 standard and SemVer 2.0.0.

Verification

  • cargo doc -j 2 --workspace --no-deps: Completed with 0 warnings or errors.
  • cargo test -j 2 --workspace: 162 unit and integration tests passing.
  • Commit signed with GPG key 29234C4D7EE749F2.

@todie
todie merged commit e4eae62 into development Oct 12, 2026
1 check passed
@todie
todie deleted the docs/repository-documentation-refresh branch October 12, 2026 14:00
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