Skip to content

Doc-accuracy pass: README/EXPLAINME/TOPOLOGY describe the pre-migration architecture (Hono, ReScript, a shipping svalinn-compose CLI, src/main.ts) #59

Description

@hyperpolymath

The prose docs still describe svalinn as it was before the ReScript→AffineScript migration (#47#51). Ground truth today: src/ is AffineScript (src/Main.affine, src/compose/*.affine); the only runnable Deno entrypoint is tools/mvp/svalinn_gateway.ts, which uses raw Deno.serve (not Hono); there is no svalinn-compose binary (src/compose/cli.ts was never created). PR #54 flagged this as a deferred, separate pass.

Stale locations (from the wrap-up audit)

README.adoc

  • L20 — "Deno-based HTTP gateway … Compose-compatible orchestration CLI (svalinn-compose)" — src/ is AffineScript; no such CLI
  • L30 / L78 — "Hono-based HTTP server" / "(Hono/Deno)" — gateway uses Deno.serve, no Hono in src/
  • L44 — status table: svalinn-compose | Complete — not built
  • L62 — architecture diagram labels Svalinn (ReScript/Deno) — now AffineScript
  • L83 — "Multi-container deployment via svalinn-compose" — not shipped
  • L119 — presents just dev/serve/build as working (broken — see Broken dev tooling: just recipes and stapeln.toml target the never-created src/main.ts (and dead ReScript steps) #58)
  • L131–157 — entire svalinn-compose subcommand section (up/down/ps/logs/scale/config) documents a CLI that doesn't exist
  • L224 — tree: main.ts # HTTP gateway entry point — never created
  • L229 — tree: compose/ # svalinn-compose orchestrator — AffineScript modules, no CLI
  • L278 — "Language Policy: Deno/TypeScript only" — contradicts CLAUDE.md (TS banned except the MVP-gateway carve-out)
  • L293 — links ReScript as a project reference — migrated out

EXPLAINME.adoc — L13/L15/L17 ("Hono-Based", src/main.ts), L21/L23 (svalinn-compose CLI at src/compose/), L54 (src/main.ts = entry point)

TOPOLOGY.md — L10 ("Deno-based … svalinn-compose CLI"), L38 (tree: compose/ # svalinn-compose CLI)

Needs maintainer judgment (why this is an issue, not an auto-fix)

  1. How to represent svalinn-compose — planned/roadmap, prototype (AffineScript), or removed? It's a product-surface decision.
  2. Migration framing — README/diagrams should align with the AffineScript direction and the superseding of D3-Ephapax per Migrate svalinn ReScript → AffineScript (tracking) — Ephapax route superseded (Stage-0 spike) #39 (the docs and STATE.a2ml currently disagree — see companion issue for STATE).

Acceptance

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions