Repository navigation
docs: standardize all spec MLI contracts - #153
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.
The 16 interfaces under
**/spec/**/*.mlidid not consistently follow the repository's journal-mli-spec structure. Organize each with TLDR first and a complete minimal usage example second, followed by applicable construction, capability, lifecycle/recovery and observation sections. Clarify state installation, typed outcomes and resource ownership in English while preserving existing API contracts and behavior.The diff is limited to these spec interfaces. Core declarations are moved where dependencies permit; large dependent signatures retain their order and use accurate linked summaries.
Validation on the final source:
dune build @app/spec/worker_coordination/all @logseq_overlay_db/spec/all @logseq_sync/spec/all @logseq_db_worker/spec/all.git diff --checkpass. Independent read-only review passes after correcting the coordinator example to use an already bootstrapped state.Remaining environment/validation blockers:
dune build @all app/native_embed.exe.oand overalldune runtest --forceexit unsuccessfully because the installed LUI lacksLui_protocol.VirtualWindowand the~virtual_rowsargument toLui_app.create_with_extensions. The successful tests above are partial regression evidence, not a fully green App run.spec-dev-tool check --allreports six pre-existing invalid decision documents; their contents are unchanged from the base revision.Source identity: base
b20511e9f23c3bae8427dab9e235d2c15cfa3b02, headdc612cbb7a669c9188027bcc9d09a68aa369e0f8; reviewed diff SHA256c6b01112d4091f99aefb9e8e2c3d60b595f75f70206f89ade608e0c2e46512e7.