Skip to content

docs: standardize readable MLI specs with TLDR and examples - #152

Merged
RCmerci merged 2 commits into
mainfrom
codex/mli-spec-readability-skill
Nov 7, 2026
Merged

RCmerci merged 2 commits into
mainfrom
codex/mli-spec-readability-skill

Conversation

@RCmerci

@RCmerci RCmerci commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

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:

  • YAML parsed successfully with Ruby; frontmatter, naming, local references and fenced blocks checked.
  • The entire skill and illustrative template were checked for English-only content.
  • git diff --check and git diff --cached --check passed.
  • Standard skill-creator quick_validate.py could not run because the local Python environment lacks PyYAML.
  • No application rebuild required for guidance-only changes.

@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-07T09:46:19.002855Z 1abb0d3 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 b20511e 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