Repository navigation
docs: link execution guide to module contracts - #157
Merged
Merged
Conversation
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Make the module contracts referenced by
journal_execution_flow.mlidirectly navigable in generated documentation..mlientries in the reading map.Only
app/spec/journal_execution_flow.mlichanges. The 10 OCaml examples and 7 trace blocks remain unchanged. No runtime/API, Dune configuration, or documentation tests are added.Validation
Validated source tree
c2c4cb1346bee3757c67581643b0d1e13167b7dewith the existinglogseq-journal-luiswitch:dune build @doctarget successfully.ocamlc -istill reports an empty exported signature.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
mainat7b180041ae829f84f0452b7684f167e829909206. 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_statewarning addressed separately by #156. Three existing Sync reference warnings (state,transition, andavailability) and six existing decision-document format failures are also outside this change. The guide itself introduces no odoc warnings.