Repository navigation
docs: standardize readable MLI specs with TLDR and examples - #152
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.
Add the repository-local journal-mli-spec skill and require MLI specifications to follow it through AGENTS.md. The fixed reading order starts with core definitions and entry points in TLDR, immediately followed by a minimal usage example; construction, capabilities, lifecycle/recovery and helpers follow as applicable.
The skill and template are written entirely in English. AGENTS.md also requires English MLI declarations, documentation, comments, section headings and explanatory example text, while preserving externally defined names and domain data where required.
The guidance covers different interface roles, OCaml declaration dependencies, ownership and persistence semantics, and preserving existing contract boundaries. This PR changes only repository guidance and the new skill.
Validation: