Commit 16b98db
docs: rewrite README + ROADMAP + EXPLAINME for outside readers (#113)
## Summary
Refreshes the three top-level overview documents (`README.adoc`,
`ROADMAP.adoc`, `EXPLAINME.adoc`) around:
1. **The actual post-2026-05-20 proof state** — the preservation
reduction story (910 → 22 open goals), the Idris2 totality campaign
outcome (8/9 `%default total`), the honest "Admitted" status replacing
the stale "all proofs closed 2026-04-27" claim.
2. **An outside-reader audience** that needs to navigate from "what is
this?" to the specific proofs / files / tests in a few clicks.
## What changed
### README.adoc
- New opening positioning: dyadic linear+affine, compile-time WASM
safety, no GC, no allocator runtime. Concrete enough to evaluate at a
glance.
- Sections reorganised: *Why "Ephapax"* / *What this is* / *What this
isn't* / *Hello-world* / *Quickstart* / *Project structure* / *Formal
foundations* / *Surface syntax* / *Component status* / *Documentation
map* / *Quickstart files by audience* / *Related work* / *Contributing*.
- **Documentation map** table links every other top-level `.adoc`/`.md`
with a one-line "what it covers" — collapses the previous flat list of
links into a navigable index.
- **Quickstart files by audience** routes outside observers, end users,
developers, and maintainers to the right file.
- **Component status table** replaces ad-hoc emoji status — adds a
"Notes" column with the actual blocking work per component.
- **Formal foundations** section separates Coq (dynamic side) from
Idris2 (structural side), names actual lemmas as Qed/Admitted, links
`PRESERVATION-HANDOFF.md` for picking up the preservation work.
### ROADMAP.adoc
- Replaces the stale "all Coq Admitted proofs closed 2026-04-27" v1.0
entry with the honest reduction-story state: preservation 22 open / 910
closed.
- New **Formal-proof status** section with per-theorem tables for both
Coq and Idris2 — single source of truth for what's
Qed/Admitted/total/covering and why.
- v0.1 blocker explicitly named: close `preservation` to Qed.
- v1.0 explicitly requires the Idris2 `Parse/Parser.idr` covering→total
upgrade.
- Cross-links to README/EXPLAINME/PROOF-NEEDS/PRESERVATION-HANDOFF at
the bottom so a reader landing on ROADMAP first can navigate outward.
### EXPLAINME.adoc
- Quotes the new README opener (the older "dyadic language — one part
affine, the other linear" line).
- New §**Claim: Mechanically Proved Soundness** section walks through
the per-theorem status with file:line citations and the reduction story
for preservation.
- §**Test Evidence** updated to "~229 tests across ~19 crates" with
explicit crate names per category.
- §**Design Documents** links the new `PRESERVATION-HANDOFF.md` +
`PROOF-NEEDS.md` + the vision document.
## Out of scope
- No proof or code changes
- Tags and description on the GitHub repo itself were updated separately
(description rewritten, added: `agda` / `idris2` / `webassembly` /
`formal-verification` / `affine-types` / `region-calculus` / `compiler`
/ `operational-semantics` / `programming-language`)
- Wiki — separate task (in flight)
## Test plan
- [x] All cross-references resolve (verified by reading)
- [x] AsciiDoc syntax valid (no compilation, but the format used is the
same idioms as the rest of the estate)
- [ ] CI green
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 5bd9fe2 commit 16b98db
3 files changed
Lines changed: 665 additions & 257 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
| 2 | + | |
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
11 | | - | |
12 | | - | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
13 | 17 | | |
14 | 18 | | |
15 | 19 | | |
| |||
141 | 145 | | |
142 | 146 | | |
143 | 147 | | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
144 | 268 | | |
145 | 269 | | |
146 | | - | |
| 270 | + | |
147 | 271 | | |
148 | | - | |
149 | | - | |
150 | | - | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
151 | 278 | | |
152 | | - | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
153 | 283 | | |
154 | 284 | | |
155 | 285 | | |
156 | | - | |
157 | | - | |
158 | | - | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
159 | 296 | | |
160 | 297 | | |
161 | 298 | | |
| |||
0 commit comments