You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore(tidy): T-5 — refresh wiki README + add honesty banners to overstated pages
## wiki/README.md rewrite
The wiki landing page had multiple structural problems:
- Linked to ~20 non-existent .md files (installation, hello-world,
expressions, errors, package-manager, lsp, formatter, linter,
primitives, collections, effects (stdlib), io, concurrency, fuzzing,
benchmarks, design/*). Every one was a broken-link click.
- Referenced `../ROADMAP.md` at root, which now lives at
`../docs/ROADMAP.adoc` after T-3 (#365).
- Pointed at `../docs/spec.md` as "Complete language specification",
but that file carries an "OUT OF DATE" banner pointing elsewhere.
- Aspirational code examples (e.g. `Vec[n + 1, T]` dependent-type
reasoning) implied enforcement that does not exist today —
CAPABILITY-MATRIX says dependent types are `parse-only`.
Rewrite drops every dead link, points at the **authoritative**
in-repo matrices (`docs/CAPABILITY-MATRIX.adoc`,
`docs/TECH-DEBT.adoc`, `docs/ECOSYSTEM.adoc`) for live status,
annotates each "Features at a Glance" example with its current
maturity (`enforced` / `partial` / `parse-only`), and updates the
Quick Links table to the post-tidy-3 docs/ paths.
The Ownership example also moved from `&File` / `&mut File` sigil
syntax to the canonical `ref File` / `mut File` keyword syntax that
the parser actually accepts at the type level (the `&T` sigil is
deliberately not added — see CAPABILITY-MATRIX CORE-01 row).
## Honesty banners
Two pages had pure-aspirational content that overstated current
enforcement:
- `wiki/language-reference/dependent-types.md` — gets a `parse-only`
banner: surface parses, but the typechecker does not reduce
predicates and there is no SMT/decision procedure. Predicates and
refinements are not enforced. Cross-link to CAPABILITY-MATRIX
"Dependent / refinement types" + TECH-DEBT CORE-05.
- `wiki/language-reference/traits.md` — gets a `partial` banner:
registry / TopTrait / TopImpl / find_impl / impl-satisfies-trait
are wired; associated-type substitution, where-clause supertraits,
and coherence checking are not. Cross-link to CAPABILITY-MATRIX
"Traits" + TECH-DEBT CORE-04.
These banners DO NOT delete content — the wiki pages still describe
the *designed* surface, useful for reading the language reference.
They just stop claiming the language enforces what it currently
parses-and-shrugs.
## What this PR does NOT do
- Doesn't add the ~20 missing wiki pages (installation, hello-world,
effects-stdlib, io, concurrency, design/*, etc.). That's content
authoring at a different scope; the README rewrite stops linking
to them, which makes the wiki navigable as-is.
- Doesn't sync to the upstream GitHub wiki repo. wiki/ is tracked in
this repo but the GitHub-wiki surface is a separate git repo; the
owner pushes wiki/ contents upstream separately. The commit message
on this PR is the cue.
- Doesn't refresh wiki/{compiler,language-reference,tooling,
stdlib,testing,tutorials}/*.md content beyond the two honesty
banners. Comprehensive content refresh of those ~30 pages is a
much larger effort and out of scope for this tidy phase.
## Test plan
- [ ] Pure-markdown PR; expected to inherit `main`'s baseline CI
state. No `.ml` / `.mli` touched.
- [ ] Hypatia: no new findings.
0 commit comments