shoney/writeonce
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
writeonce/docs/stories/language-runtime-database/01-principles-doc.md
shoney.arickathil c0b0dbb846 docs: audit all markdown against the code, fix findings, flatten status folders 
- README: shipped concurrency/HTTP/WebSockets sat in the roadmap as "not yet
  available"; "no package manager" contradicted [deps]; the deps example
  would not have compiled (the key IS the module name)
- runtime/README: leads with wovm, wo-rt.c demoted to a historical section;
  dropped 2 nonexistent recipes, crates/rt, @gc refcounting, 13 suites -> 18
- employee + log-watcher READMEs claimed "does not compile"; both are gates
- error catalog: +10 emitted codes incl WO-E250, the only diagnostic the
  shipped query surface raises; recorded why the sweep rotted
- language-surface: group-by parses, then the typechecker refuses it
- 00-code-review + 00-link-audit re-run; history kept, not rewritten
- 48 dead Rust-era exploration links de-linked rather than re-pointed (their
  prose names the retired plan by number); successor map -> discarded.md
- 08-project-structure: compiler/plan/ never existed; corpus has 9 dirs, 5 empty
- releasing.md: dropped a --draft step the workflow never had
- new docs/00-doc-audit.md: findings + disposition, incl one row where the
  audit was wrong and the doc it accused was right
- status folders removed: 34 stories flat, status only in frontmatter; 252
  links recomputed from resolved paths; board/board-views/structure retaught
- story 24 -> in-progress, since frontmatter is now the only truth
- new iteration 38: fs mutation verbs + net.connect, the two capability
  families no iteration owned
- new iteration 39: gofiber/fiber v3.5.0 parity study. The ledger called
  CSRF/sessions unblocked by iteration 34's HMAC, but the runtime has no
  source of randomness at all
- linkcheck skips .dev/.superpowers: 0 broken paths, 0 bad anchors

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-26 19:20:22 +02:00

2 KiB
Raw Blame History

iteration status
1 done

Iteration 1 — the principles doc

Format: product/story-iteration-template. Part of Story — one language, one runtime, one database, one binary.

Goals

  • The repo gains docs/00-principles.md: one page stating the twelve writeonce principles — the doctrine every later iteration links back to instead of re-arguing.
  • The twelve: one binary is the whole system; zero dependencies (kernel primitives only); memory safety without a GC tax (MVS ownership, opt-in @gc, per-shard collection); no inheritance ever; thread-per-core shards with ownership moves; the runtime never stops (blue-green slots, embedded source); RAM authoritative + WAL durable; samples force the grammar; Linux is the target; capabilities are typed builtins (no FFI); plain diagnostics are the product; the runtime is a recipe box.

Acceptance Criteria

  • What to achieve?
    • Given a new contributor opening docs/,
    • when they read docs/00-principles.md,
    • then each principle is a short statement plus a one-line why plus a link to the spec or doc that enforces it, and no principle contradicts a locked spec decision.
  • What to achieve?
    • Given CLAUDE.md's "Where to read next" list,
    • when the iteration lands,
    • then it contains one pointer line to the principles doc and nothing else about it changed.

Out Of Scope

  • Rewriting or relocating existing doctrine text in specs/plans — the doc links, it does not duplicate.
  • Any .wo example content (iterations 2+ own code-adjacent artifacts).

Info

  • docs/ numbering starts at 01-problem.md; the 00- slot is free and reads as "start here".
  • Spec governing this slice: docs/superpowers/specs/2026-08-07-logwatcher-sample-and-principles-design.md §3.

Proposed Solution

  • Author the page with the twelve principles in the order listed in the governing spec; verify every link resolves; add the CLAUDE.md pointer line; record the commit draft in .dev/commit.md.