Skip to content

docs+proofs: reintroduce architecture/build/install/usage + proofs scaffolding (follow-up to #102)#120

Merged
hyperpolymath merged 1 commit into
mainfrom
docs/reintroduce-architecture-build-install-proofs
Jun 2, 2026
Merged

docs+proofs: reintroduce architecture/build/install/usage + proofs scaffolding (follow-up to #102)#120
hyperpolymath merged 1 commit into
mainfrom
docs/reintroduce-architecture-build-install-proofs

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Summary

Restores the 8 docs+proofs files that PR #81 added but #102 had to drop while reverting #81's wrong-direction license change. Per #102's PR body:

"Reverting #81 also dropped 4 new docs + proofs/ scaffolding... These can be reintroduced cleanly in a separate, license-free PR after this lands."

This is that PR.

Files (all NEW, no edits to existing content)

File Purpose
docs/architecture.adoc LSM/ESN/bridge architecture (149 lines)
docs/build.adoc Build instructions (72 lines)
docs/installation.adoc Installation guide pointed-to by README (113 lines)
docs/usage.adoc Usage docs (41 lines)
proofs/README.adoc Proof corpus index
proofs/dafny/README.adoc Dafny/F* proofs subdirectory
proofs/lean/README.adoc Lean/Coq proofs subdirectory
proofs/tla/Lifecycle.tla TLA+ lifecycle obligation 2.1 (issue #84)

Licensing

All 8 files carry `SPDX-License-Identifier: MPL-2.0` per the canonical estate license policy (neurophone = sole-owner repo). #81 had originally added these with PMPL stamps; this PR adds them with the correct MPL-2.0 SPDX from the start.

Verification

```sh
grep -r 'SPDX-License-Identifier' docs/architecture.adoc docs/build.adoc \
docs/installation.adoc docs/usage.adoc proofs/
```

All 8 files report `MPL-2.0`.

Test plan

  • CI green (no new SPDX violations)
  • Files render correctly (asciidoctor + TLA+ syntax)
  • `docs/installation.adoc` link from README.adoc resolves

Why draft

License sweep aftermath; owner sight on docs reintroduction before flipping to ready.

…fs scaffolding

Restores the 4 docs + proofs/ scaffolding that PR #81 added but #102 had
to drop while reverting #81's wrong-direction license change. Per #102's
PR body: "These can be reintroduced cleanly in a separate, license-free
PR after this lands."

## Files (all NEW, no edits to existing content)

- docs/architecture.adoc (149 lines)
- docs/build.adoc (72 lines)
- docs/installation.adoc (113 lines)
- docs/usage.adoc (41 lines)
- proofs/README.adoc (corpus index)
- proofs/dafny/README.adoc
- proofs/lean/README.adoc
- proofs/tla/Lifecycle.tla (TLA+ lifecycle obligation 2.1 / issue #84)

## Licensing

All 8 files carry `SPDX-License-Identifier: MPL-2.0` per the canonical
estate license policy (neurophone is a sole-owner repo). #81 had
originally added these with PMPL stamps; this PR adds them with the
correct MPL-2.0 SPDX from the start.

## Verification

```sh
grep -r 'SPDX-License-Identifier' docs/architecture.adoc docs/build.adoc \
  docs/installation.adoc docs/usage.adoc proofs/
```

All 8 files report `MPL-2.0`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@hyperpolymath
hyperpolymath marked this pull request as ready for review June 2, 2026 19:38
@hyperpolymath
hyperpolymath enabled auto-merge (squash) June 2, 2026 19:38
@hyperpolymath
hyperpolymath merged commit 10f440a into main Jun 2, 2026
23 checks passed
@hyperpolymath
hyperpolymath deleted the docs/reintroduce-architecture-build-install-proofs branch June 2, 2026 19:48
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