Skip to content

docs: link execution guide to module contracts - #157

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

RCmerci merged 1 commit into
mainfrom
codex/journal-doc-links-20261107

Conversation

@RCmerci

@RCmerci RCmerci commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Make the module contracts referenced by journal_execution_flow.mli directly navigable in generated documentation.

  • Add contract links for the seven pseudocode module aliases.
  • Link all ten .mli entries in the reading map.
  • Link the external boundary modules referenced in the prose.
  • Use 22 odoc cross-references resolving to 13 existing module pages.

Only app/spec/journal_execution_flow.mli changes. The 10 OCaml examples and 7 trace blocks remain unchanged. No runtime/API, Dune configuration, or documentation tests are added.

Validation

Validated source tree c2c4cb1346bee3757c67581643b0d1e13167b7de with the existing logseq-journal-lui switch:

  • Ran the normal local dune build @doc target successfully.
  • Inspected the actual generated HTML: all 68 local links and anchors resolve, including all 22 contract references; no unresolved-reference markup or missing target files.
  • Confirmed that the referenced module pages match the public Dune module owners.
  • ocamlc -i still reports an empty exported signature.
  • Source examples/traces, diff hygiene, and independent read-only review passed.

Code and trace blocks remain literal code. The adjacent alias navigation and reading-map links open the corresponding contracts.

Base and existing warnings

This PR is based directly on main at 7b180041ae829f84f0452b7684f167e829909206. It does not include or depend on the still-open shutdown-reference fix in #156.

The local build therefore still reports the existing coordinator shutdown_state warning addressed separately by #156. Three existing Sync reference warnings (state, transition, and availability) and six existing decision-document format failures are also outside this change. The guide itself introduces no odoc warnings.

@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-07T14:17:15.764155Z a2b6bd8 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 17cc505 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