Skip to content

docs: include Journal execution guide in Dune odoc output - #155

Merged
RCmerci merged 2 commits into
mainfrom
codex/journal-doc-integration-20261107
Nov 7, 2026
Merged

RCmerci merged 2 commits into
mainfrom
codex/journal-doc-integration-20261107

Conversation

@RCmerci

@RCmerci RCmerci commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Fix the missing normal-project documentation output for the execution guide introduced in #154.

  • Keep app/spec/journal_execution_flow.mli unchanged as the sole body source.
  • Generate its manual page through Dune and attach it to the logseq_journal package.
  • Add a package homepage linking the execution guide and the existing coordination API.
  • Document how to build and open the generated package homepage.

The final diff contains only app/spec/dune, app/spec/index.mld, and app/spec/README.md. No documentation tests, runtime modules, libraries, exported APIs, or source-boundary changes are added.

Validation

Validated source tree d21b35e171c38d5a23667bf931838362691711b3 in the existing locked logseq-journal-lui switch:

  • dune build @all app/native_embed.exe.o @doc -j 3: passed.
  • Manually inspected the generated package homepage and execution-guide HTML, including the guide's beginning and ending. Confirmed the homepage links to the generated guide and coordination API, with working relative paths back to the package and root indexes.
  • dune runtest --force -j 3: existing suite passed; 1,339 Alcotest cases across 22 suites, 24 positive/31 negative coordination contracts, and clean source-boundary checks.
  • Dune formatting and diff hygiene passed. The existing test/ tree and the source .mli are unchanged from the base.

After dune build @doc, open _build/default/_doc/_html/logseq_journal/index.html; its guide link resolves to journal_execution_flow.html.

Existing issues and scope

spec-dev-tool check --all still reports these six pre-existing decision-document format failures. Its complete output is byte-for-byte identical on the base and this change:

  • docs/agent-guide/001-fixed-timeline-hosts.md
  • docs/agent-guide/implemented/architecture/2026-10-19-local-only-startup-network-gate.md
  • docs/agent-guide/implemented/bugfix/2026-10-06-timeline-soft-scroll-edge.md
  • docs/agent-guide/implemented/bugfix/2026-10-09-favorites-native-soft-header.md
  • docs/agent-guide/implemented/bugfix/2026-10-20-encrypted-graph-raw-assets.md
  • docs/agent-guide/implemented/feature/2026-09-28-bottom-lui-capsules.md

Existing odoc ambiguous-reference warnings are unchanged. No Apple packaging or GUI acceptance was run for this documentation-only integration.

@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:38:01.372544Z 745fcea 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 7b18004 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