Public: anyone can read this; the crew can change it.

docs/TECHNICAL.md names every module in src/, and a test fails when a new one is left out #268

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

docs/TECHNICAL.md now names the eight modules it was missing, and a new test fails when a src/ module isn't named in the docs. src/readme.test.ts passes. With the docs change stashed it fails and names the missing files, so it does catch an omission.

Notes

shipped production is serving it deploy d2eada7

opened this

docs/TECHNICAL.md now names the eight modules it was missing, and a new test fails when a src/ module isn't named in the docs. src/readme.test.ts passes. With the docs change stashed it fails and names the missing files, so it does catch an omission. I did not run bun x tsc --noEmit successfully: it printed its help text instead of type-checking, so the type check did not run. I ran only src/readme.test.ts, not the full suite.

  • Docs: coming.ts, find.ts, guidance.ts, memo.ts, money.ts, profile.ts, progress.ts and settled.ts each have a row in the "The shape" table. Each row gives the module's one concept, what goes in and out, and who calls it. I read each module and grepped its importers for the callers.
  • Test: it lists the non-test .ts files directly in src/. It fails, listing the file names, when one isn't written as src/<name> in docs/TECHNICAL.md or AGENTS.md.

No code changed, and every module's concept was clear from its header comment. I did not run scripts/gate.ts or scripts/fast.ts.

To try it: bun test src/readme.test.ts.

🤖 Generated with Claude Code

Closes #266

commented

docs/TECHNICAL.md now names the eight modules it was missing, and a new test fails when a src/ module isn't named in the docs. src/readme.test.ts passes. With the docs change stashed it fails and names the missing files, so it does catch an omission. I did not run bun x tsc --noEmit successfully: it printed its help text instead of type-checking, so the type check did not run. I ran only src/readme.test.ts, not the full suite.

  • Docs: coming.ts, find.ts, guidance.ts, memo.ts, money.ts, profile.ts, progress.ts and settled.ts each have a row in the "The shape" table. Each row gives the module's one concept, what goes in and out, and who calls it. I read each module and grepped its importers for the callers.
  • Test: it lists the non-test .ts files directly in src/. It fails, listing the file names, when one isn't written as src/<name> in docs/TECHNICAL.md or AGENTS.md.

No code changed, and every module's concept was clear from its header comment. I did not run scripts/gate.ts or scripts/fast.ts.

To try it: bun test src/readme.test.ts.

🤖 Generated with Claude Code

Approved

Docs-only plus one test. The eight modules each have a row (concept, in/out, callers) and the callers check out against the importers. The new test lists non-test .ts files directly in src/ and fails by name when one is not written as src/<name> in the docs; it passes at this head. No contract cell, dependency or runtime code touched.

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs