Reorganize: move non-README docs into docs/ subfolder
Some checks are pending
Lean Action CI / build (push) Waiting to run
Some checks are pending
Lean Action CI / build (push) Waiting to run
Standard convention: README.md at root, everything else in docs/. Engine docs/: FFI_DESIGN, FFI_COMPLETENESS, KERNEL_BOUNDARY, NUMERICAL, PHASE1_HISTORY, ZIGZAG_PORT. README.md links updated to docs/<name>. Cross-repo reference in NUMERICAL.md (to topolei's STATUS.md) now includes the relative path `../topolei/docs/STATUS.md`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
8561e19467
commit
d9f952fa6c
7 changed files with 13 additions and 12 deletions
16
README.md
16
README.md
|
|
@ -45,15 +45,15 @@ lake build
|
||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
|
|
||||||
- `FFI_DESIGN.md` — C ABI contract between Lean and the Rust kernel.
|
- `docs/FFI_DESIGN.md` — C ABI contract between Lean and the Rust kernel.
|
||||||
- `FFI_COMPLETENESS.md` — per-function axiom audit.
|
- `docs/FFI_COMPLETENESS.md` — per-function axiom audit.
|
||||||
- `KERNEL_BOUNDARY.md` — what this delivers in unmodified Lean 4 vs.
|
- `docs/KERNEL_BOUNDARY.md` — what this delivers in unmodified Lean 4 vs.
|
||||||
what would need upstream Lean kernel work.
|
what would need upstream Lean kernel work.
|
||||||
- `NUMERICAL.md` — numerical implementation principles.
|
- `docs/NUMERICAL.md` — numerical implementation principles.
|
||||||
- `PHASE1_HISTORY.md` — original transport/composition formalisation
|
- `docs/PHASE1_HISTORY.md` — original transport/composition formalisation
|
||||||
plan (archived; Phase 1 closed; preserved as methodology template
|
plan (archived; Phase 1 closed; preserved as methodology template
|
||||||
for future phases).
|
for future phases).
|
||||||
- `ZIGZAG_PORT.md` — step-by-step Lean port plan for the n-category
|
- `docs/ZIGZAG_PORT.md` — step-by-step Lean port plan for the n-category
|
||||||
combinatorial engine (Phase 2+ higher-cell backend). Lands here
|
combinatorial engine (Phase 2+ higher-cell backend). Lands here
|
||||||
in the engine. **Read the cascade caveat at the top before
|
in the engine. **Read the cascade caveat at the top before
|
||||||
editing**: changes in the ported zigzag layer cascade to the
|
editing**: changes in the ported zigzag layer cascade to the
|
||||||
|
|
@ -64,5 +64,5 @@ lake build
|
||||||
## Used by
|
## Used by
|
||||||
|
|
||||||
- [`max/topolei`](../topolei) — the cells-spec workspace interface,
|
- [`max/topolei`](../topolei) — the cells-spec workspace interface,
|
||||||
built on this engine. See its `cells-spec.md` and `STATUS.md` for
|
built on this engine. See its `docs/cells-spec.md` and
|
||||||
the application-side picture.
|
`docs/STATUS.md` for the application-side picture.
|
||||||
|
|
|
||||||
|
|
@ -109,10 +109,11 @@ enforces three properties:
|
||||||
implementations for axiom-stated behaviors
|
implementations for axiom-stated behaviors
|
||||||
(`@[extern "topolei_cubical_eval"] opaque cubicalEval : CEnv → CTerm → CVal`).
|
(`@[extern "topolei_cubical_eval"] opaque cubicalEval : CEnv → CTerm → CVal`).
|
||||||
Each Rust function's behavior is specified by a Lean axiom it
|
Each Rust function's behavior is specified by a Lean axiom it
|
||||||
must satisfy (e.g., `eval_var` / `eval_lam` / … in `Cubical/Eval.lean`,
|
must satisfy (e.g., `eval_var` / `eval_lam` / … in
|
||||||
or `readback_vneu` / … in `Cubical/Readback.lean`). Step-level
|
`CubicalTransport/Eval.lean`, or `readback_vneu` / … in
|
||||||
axioms are derived from the eval/readback contract via the Week 7
|
`CubicalTransport/Readback.lean`). Step-level axioms are derived
|
||||||
bridge — see `STATUS.md`.
|
from the eval/readback contract via the Week 7 bridge — see
|
||||||
|
`STATUS.md` in the topolei repo (`../topolei/docs/STATUS.md`).
|
||||||
|
|
||||||
3. **IO tagging.** Any effect (GPU dispatch, memory allocation,
|
3. **IO tagging.** Any effect (GPU dispatch, memory allocation,
|
||||||
timing, parallelism) is wrapped in `IO` so it cannot leak into
|
timing, parallelism) is wrapped in `IO` so it cannot leak into
|
||||||
Loading…
Add table
Reference in a new issue