Skip to content

docs(integrations): describe effort-only role saves in the translated guides - #6976

Merged
lidge-jun merged 2 commits into
devfrom
codex/6975-effort-only-locale-docs-261012
Oct 12, 2026
Merged

lidge-jun merged 2 commits into
devfrom
codex/6975-effort-only-locale-docs-261012

Conversation

@lidge-jun

@lidge-jun lidge-jun commented Oct 12, 2026 •

Copy link
Copy Markdown
Owner

Summary

#6975 (now on dev) lets a row whose role has no model pin save an effort on its own. This carries that behavior into the fr, ja, ko, ru, tr, zh-cn and zh-tw guides that #6970 added, and narrows one English sentence #6975 added.

  • Translations. The first paragraph says a row without a model pin can save an effort alone, and the role keeps inheriting its model. A new paragraph after the Inherit effort paragraph covers PUT /api/codex-agent-roles/{role}. Omitting model keeps the role-file pin and the omo.jsonc model, and the dashboard sends that effort-only request for such rows. A null model is refused with 400 invalid_model. A body with neither model nor effort is refused with 400 empty_update before any file is read. ocx agent roles set always takes a model.
  • English. fix(codex): save a model-inheriting LazyCodex role's effort without pinning a model #6975 said a role without an omo.jsonc entry "gets one holding only reasoning". writeOmoRoleModel (src/clients/omo-role-models.ts) creates that entry only when the saved effort is one LazyCodex supports (omoReasoningFor writes none as off). For a role without an entry, a clear or ultra passes null and the writer returns unchanged. The sentence now says this and is scoped to the absent-entry case; an existing entry still loses its older reasoning on a clear or ultra, as the paragraph above it says. The translations already used this narrower wording.

#6975 also changed the GUI omoComments string to [codex].agents.{role}. That needs no guide edit, because the guides only say to set the value by hand.

Co-authored-by: LilMGenius smsmeee@naver.com

Verification

  • cd docs-site && bun install --frozen-lockfile && ASTRO_TELEMETRY_DISABLED=1 bun run build: exit 0, 569 pages, 79353 internal links checked.
  • bun test tests/ci-workflows/docs-*.test.ts tests/ci-workflows/file-size-ratchet.test.ts tests/ci-workflows/repo-hygiene.test.ts tests/ci-workflows/structure-ssot.test.ts tests/ci-workflows/skill-ocx-workflows.test.ts tests/codex-integration/codex-inject-history-wording.test.ts: 419 pass, 0 fail.
  • bun run structure:check, bun run privacy:scan, git diff --check origin/dev: exit 0.
  • Docs-only change, so typecheck and the full suite are left to CI. Two independent cross-model audits (GPT-6.1-Sol high) checked the translations and the English sentence against fix(codex): save a model-inheriting LazyCodex role's effort without pinning a model #6975's code. Both returned NEAR-PASS. Their findings are folded in: the reasoning-only entry condition, and the absent-entry scope.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults.

Summary by CodeRabbit

  • Documentation
    • Updated the omo integration guides to explain how to change or clear a role’s reasoning effort without changing its inherited or pinned model.
    • Clarified when saving an effort creates a reasoning-only LazyCodex entry and documented validation errors for unsupported or empty updates.
    • Noted that the CLI still requires a model when setting a role.

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: lidge-jun/opencodex/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 08575f46-08df-4692-af0e-b7ce98f1ef6b

📥 Commits

Reviewing files that changed from the base of the PR and between a0191a1 and a3ffac1.


📒 Files selected for processing (8)
  • docs-site/src/content/docs/fr/guides/integrations.md
  • docs-site/src/content/docs/guides/integrations.md
  • docs-site/src/content/docs/ja/guides/integrations.md
  • docs-site/src/content/docs/ko/guides/integrations.md
  • docs-site/src/content/docs/ru/guides/integrations.md
  • docs-site/src/content/docs/tr/guides/integrations.md
  • docs-site/src/content/docs/zh-cn/guides/integrations.md
  • docs-site/src/content/docs/zh-tw/guides/integrations.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 2 remain after this review.



📝 Walkthrough

Walkthrough

Integration guides in eight locales now describe effort-only updates for omo roles, including model inheritance, effort clearing, LazyCodex entry creation, API validation errors, and the CLI model requirement.

Changes

Omo role effort documentation

Layer / File(s) Summary
Document effort-only role updates
docs-site/src/content/docs/guides/integrations.md, docs-site/src/content/docs/*/guides/integrations.md
The guides explain that omitting model preserves existing model settings while effort can be saved or cleared. They describe when a reasoning-only omo.jsonc entry is created, the relevant API errors, and the CLI requirement to specify a model.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: lcxhh521


Merge Risk: ⚪ Minimal · up to a3ffa

No actionable documentation mismatch remains established for this change, so it presents no identified merge-blocking risk.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies a documentation change in the integrations guides and accurately describes the main update: effort-only role saves in translated guides.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

lidge-jun and others added 2 commits October 12, 2026 16:43
Mirror #6975's English role-models text in the fr, ja, ko, ru, tr, zh-cn
and zh-tw guides: a row without a model pin can save an effort alone,
omitting model keeps the role-file pin and the omo.jsonc model, a missing
omo.jsonc entry gets reasoning only when a supported level is stored, a
null model is refused with 400 invalid_model, an empty update with 400
empty_update, and ocx agent roles set always takes a model.

Co-authored-by: LilMGenius <smsmeee@naver.com>
#6975's English said a role without an omo.jsonc entry always gets one
holding only reasoning. writeOmoRoleModel only creates it when a level
LazyCodex supports is saved (none is written as off); for such a role a
clear or ultra adds no entry. The translations already say this.

Co-authored-by: LilMGenius <smsmeee@naver.com>
@lidge-jun
lidge-jun force-pushed the codex/6975-effort-only-locale-docs-261012 branch from 1fd9f11 to a3ffac1 Compare October 12, 2026 07:44
@lidge-jun
lidge-jun marked this pull request as ready for review October 12, 2026 07:44
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner October 12, 2026 07:44
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-12T07:47:36.816875Z a3ffac1 Draft marked ready
ℹ️ 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.

@Ingwannu Ingwannu left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed documentation head a3ffac15d2d58ec2f5fee56aba9cc57c9adb6661 against trusted dev a0191a1b6fd921a6e5a9d12cb123c8df88b023e7.

The effort-only descriptions agree with the current route and omo writer: omitted model preserves inheritance/pins, null model is rejected, an empty update is refused before role/omo file reads, and a missing omo role entry is created only for a supported reasoning value. The English correction correctly excludes clear/ultra from absent-entry creation; none maps to off. I found no concrete contract blocker in the changed guide text. This is factual documentation review, not an autonomous UI/translation redesign.

Exact-head Cross-platform CI run 38219447006 completed successfully. I did not rerun a docs build or runtime suite for unchanged implementation. The latest target/readiness run 38219722923 remains pending at this check; prior cancelled gate runs are not passes. This comment does not waive that gate or independently certify every locale's idiomatic phrasing.

@lidge-jun
lidge-jun merged commit 49ae1f7 into dev Oct 12, 2026
32 of 38 checks passed
@lidge-jun
lidge-jun deleted the codex/6975-effort-only-locale-docs-261012 branch October 12, 2026 10:56
@lidge-jun

Copy link
Copy Markdown
Owner Author

Maintainer integration into dev (actor @lidge-jun, admin), merged as 49ae1f7; head a3ffac15d2 bound with --match-head-commit, no unresolved threads. Exact-head checks 11 pass / 15 skipped (docs-only; the earlier enforce-target failures were concurrency-group cancellations and the rerun passed). Author verification: docs-site build 0 (569 pages), docs ci-workflows tests 419/0, structure:check and privacy:scan 0; GPT-6.1-Sol high audit NEAR-PASS with the scope finding folded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants