[OCaml] High Intensity Training Online
chore Log iteration 1 of the documentation review
Record the ARCHITECTURE.org and comment STE100 passes, the workout doc fix, and the remaining per-.mli accuracy audit.
RAIL.org
@@ -7,6 +7,47 @@
7
7
#+TAGS: [ Impact : minor major ]
8
8
#+TAGS: [ Misc : doctrine ]
9
9
10
Added:
* IN-PROGRESS Review docs and comments vs code, apply STE100 :docs:app:minor:
11
Added:
SCHEDULED: [2026-09-09 Wed 15:54]
12
Added:
:PROPERTIES:
13
Added:
:ID: 57F53575-3575-47F2-9926-FE19F721F063
14
Added:
:END:
15
Added:
:LOGBOOK:
16
Added:
- [2026-09-09 Wed 16:05] Iteration 1 progress. Commits: e09319d
17
Added:
(ARCHITECTURE.org accuracy + STE100), 5b53df8 (STE100 comment pass
18
Added:
across 20 lib/bin files, verified comment-only via zero added
19
Added:
semicolons and diff inspection), 555e3fb (fixed stale pages.mli
20
Added:
workout doc: dropdown not button group; repaired broken [active_slot]
21
Added:
fragment). 245 tests green; build @check + @fmt clean.
22
Added:
23
Added:
Verified accurate: core doctrine constants match docs (stall_window 14d, load_increase_trigger 12, Rep_range.limits (6,12), training_interval 48h, cycle_rest 72h); Service/Handlers functor arities now documented as (Repository.S)(Password_hash.S); Evidence delivery Single/Pair; route table matches routes.ml; data-hito-dialog-open exists. No contractions/Latin abbreviations anywhere.
24
Added:
25
Added:
Remaining accuracy audit (iterations 2+): read each remaining .mli doc vs its .ml for drift — priority on evidence.mli, recovery.mli, exercise.mli, repository.mli, codec.mli, migrations.mli, sqlite_repo.mli, decode.mli, handlers.mli, service.mli, trainee.mli, catalog.mli. Also scan inline .ml comments for factual drift (the STE subagent reported no inaccuracies but did not do a full accuracy audit). Confirm ARCHITECTURE.org route table, markers table, and env-var table still match after any further code reading. Keep build @check/@fmt clean; docs are prose so no test impact expected.
26
Added:
:END:
27
Added:
Goal: review and update all project documentation and comments against
28
Added:
the actual implementation, adhering to STE100 (Simplified Technical
29
Added:
English, per .kiro steering).
30
Added:
31
Added:
Surfaces: ARCHITECTURE.org (done), 19 .mli interface docs + inline .ml
32
Added:
comments. RAIL.org and .agent-shell transcripts are logs, not
33
Added:
implementation docs — out of scope. doc/ is the copyrighted HD1
34
Added:
reference — excluded. No README exists.
35
Added:
36
Added:
Iteration 1: audited ARCHITECTURE.org against code and fixed
37
Added:
inaccuracies (Service/Handlers now functors over Repository.S AND
38
Added:
Password_hash.S; named Password_hash port + Bcrypt_hash adapter in the
39
Added:
layer diagram; added View_model to the web tier; recorded
40
Added:
test_architecture and test_bcrypt_hash suites). Applied STE100: split
41
Added:
~19 prose semicolons into sentences (kept the two inside OCaml record
42
Added:
code spans), fixed one phrasal verb. Verified no contractions and no
43
Added:
Latin abbreviations anywhere in ARCHITECTURE.org or in any lib/bin
44
Added:
comment. Committed e09319d.
45
Added:
46
Added:
Remaining: STE100 pass over ~40 code-comment lines carrying prose
47
Added:
semicolons across lib/{core,app,web,persistence} .ml/.mli, plus a
48
Added:
per-file accuracy check that each .mli doc still matches its
49
Added:
implementation. Must keep dune build @check clean and change no
50
Added:
interface contract. Build dir _build-agent.
10
51
* DONE Pass view models across the web boundary, not entities :refactor:web:major:
11
52
CLOSED: [2026-09-09 Wed 15:26] SCHEDULED: [2026-09-09 Wed 14:46]
12
53
:PROPERTIES: