docs/README.md

GitHub

Docs Index

Start with architecture.md — what wakaru does, the pipeline flow, and the design patterns every change touches. Everything else is read-on-demand by task. Don't read the whole directory; use the map.

For rule ordering, stages, and enforced edges, the registry in crates/core/src/rules/pipeline.rs is authoritative — the docs explain why, the registry defines what.

Read by task

Task Read
Any code change testing.md — test patterns, helpers, required verification before commit
Rule bugfix / snapshot regression debugging.md — rule tracing, snapshot layers, fixture workflow
New rule, or moving a rule rule-dependency-inventory.md — ordering rationale, fragile edges, experiment log; rewrite-assumptions.md — level gating and named assumptions
Transpiler helper work helper-detection.md — detection design and rejected alternatives
Cross-module / unpack behavior fact-system.md — the two-phase barrier and module facts
Vue SFC recovery (--vue-sfc) vue-decompile.md — the recovery path and CLI behavior; vue-sfc-recovery-status.md — experimental status and known gaps
Correctness / semantics questions rewrite-assumptions.md; test262-roundtrip.md — the semantic round-trip harness
Before proposing a redesign learnings/ — approaches already built, measured, and reverted
CLI flag or output changes cli.md — the user-facing CLI reference; ../SKILL.md — the agent skill (keep both in sync)
Agent / tool integration ../SKILL.md — the CLI-based agent surface
Cutting a release releasing.md

Data directories

  • test262-baselines/ — tracked canonical Test262 JSON baselines and Markdown summaries (current totals cached in scripts/correctness/test262-stats.json)
  • proposals/ — design proposals, deferred or in progress
  • learnings/ — post-mortems of measured-and-reverted approaches