Skip to content

docs: explain Journal execution flows with spec types - #154

Merged
RCmerci merged 1 commit into
mainfrom
codex/journal-flow-spec-20261107
Nov 7, 2026
Merged

RCmerci merged 1 commit into
mainfrom
codex/journal-flow-spec-20261107

Conversation

@RCmerci

@RCmerci RCmerci commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add app/spec/journal_execution_flow.mli, a documentation-only walkthrough of Journal's App, Worker and Sync paths using existing spec types and API calls.
  • Cover startup/baseline, typed reads, Capture and durable mutation, presentation confirmation, nested Sync execution, snapshot bootstrap, outbox/pull, observations, media resources and lifecycle handoff.
  • Keep host/Service seams explicit. The file exports an empty signature and adds no runtime API or Dune library.
  • Link the guide from app/spec/README.md.
  • Adapt the source-boundary check only for this exact guide: it must remain one complete odoc comment with no declarations. Two positive and seven negative guard cases preserve the App dependency boundary.

Validation

Validated the exact source tree a4891cb1b9b382a59fa84bc8e30d2211f20cdfef with the prepared logseq-journal-lui switch (OCaml 5.5.0, Dune 3.23.1):

  • dune build @all app/native_embed.exe.o: passed.
  • dune runtest --force: passed, including 1,339 Alcotest cases across 22 suites, 24 positive/31 negative coordination contracts, and the source-boundary check.
  • All 10 OCaml documentation blocks typechecked against the built public interfaces.
  • Empty exported signature verified; odoc compile/link with --warn-error and HTML generation passed.
  • Independent read-only review completed; the commit/outbox notification order finding was fixed and rechecked.
  • git diff --check: passed.

Existing limitation

spec-dev-tool check --all still reports six pre-existing decision-document format failures. Its output matches clean main byte-for-byte; those unrelated documents are unchanged.

No production behavior, dependency, Dune, packaging or GUI changes.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-07T13:21:18.887494Z f69da5b PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@RCmerci
RCmerci merged commit 7a93ee0 into main Nov 7, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant