Skip to content

docs: clarify encrypted combo recovery fallback outcomes - #3763

Merged
lidge-jun merged 1 commit into
devfrom
codex/release-244-recovery-doc-alignment-07c0
Sep 6, 2026
Merged

docs: clarify encrypted combo recovery fallback outcomes#3763
lidge-jun merged 1 commit into
devfrom
codex/release-244-recovery-doc-alignment-07c0

Conversation

@lidge-jun

@lidge-jun lidge-jun commented Sep 6, 2026

Copy link
Copy Markdown
Owner

Summary

Verification

  • Compared the four pages against the current recovery branches and stored-Pool regression contract. The underlying runtime head 8de1269 passed CI34025899357.
  • This documentation head has its own hosted CI; no local tests, typecheck or documentation build were run under the owner's instruction.

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.

Manual dependent PR above #3762. No authentication, credential handling or runtime policy change.

Summary by CodeRabbit

  • Documentation
    • Clarified that encrypted sub-agent tasks may use an eligible recovery route when native targets are unavailable or their attempts are exhausted.
    • Documented that unreadable encrypted content is not forwarded when recovery cannot provide a usable destination.
    • Clarified error handling before and after native attempts, while preserving cancellation behavior and existing authorization, quota, and persistence boundaries.
    • Updated French, Simplified Chinese, and Traditional Chinese documentation for consistency.

Sidecar verification

Exact-head Cross-platform CI 34026723367 completed SUCCESS on 384dea7 (docs aggregate ci). After #3762 merge, this PR base is current dev; head preserved with no rebase. Maintainer-integration choice: admin merge into current dev after assert-mergeable-review.sh --maintainer-integration 3763; no branch delete. Codex P2 locale-consistency comment on French agents.md vs English reference is not a runtime/security finding and is not silently resolved here.

@coderabbitai

coderabbitai Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 857d2bea-6fc8-4eca-88c4-97c1b5be72b0

📥 Commits

Reviewing files that changed from the base of the PR and between f00f2bc and 384dea7.

📒 Files selected for processing (5)
  • devlog/_plan/260906_release_244_followups/082_recovery_doc_alignment.md
  • docs-site/src/content/docs/fr/reference/configuration/agents.md
  • docs-site/src/content/docs/guides/sub-agent-surface.md
  • docs-site/src/content/docs/zh-cn/reference/configuration/agents.md
  • docs-site/src/content/docs/zh-tw/reference/configuration/agents.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The change adds a recovery documentation plan and updates English, French, Simplified Chinese, and Traditional Chinese documentation. The text covers native-attempt exhaustion, recovery failure responses, and prevention of unreadable ciphertext forwarding. No runtime code changes are included.

Changes

Recovery documentation alignment

Layer / File(s) Summary
Recovery behavior and verification scope
devlog/_plan/.../082_recovery_doc_alignment.md, docs-site/src/content/docs/guides/sub-agent-surface.md, docs-site/src/content/docs/{fr,zh-cn,zh-tw}/reference/configuration/agents.md
The documentation describes recovery after native targets are unavailable or exhausted. It states that unreadable ciphertext is not forwarded when recovery cannot produce a usable task. It preserves the distinction between pre-dispatch unreadable_encrypted_agent_task and errors from failed native attempts. The planning document records unchanged authentication, quota, persistence, and cancellation boundaries.

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

Merge Risk: ⚪ Minimal · up to 384de

The documentation clarifies encrypted sub-agent recovery after native-target exhaustion and preserves the fail-closed handling of unreadable ciphertext. No runtime behavior changes or merge-blocking risks are identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documentation updates that clarify encrypted combo recovery fallback outcomes.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/release-244-recovery-doc-alignment-07c0

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.

Base automatically changed from codex/release-244-usage-source-07c0 to dev September 6, 2026 10:21
@lidge-jun
lidge-jun marked this pull request as ready for review September 6, 2026 10:23
@lidge-jun
lidge-jun requested a review from Ingwannu as a code owner September 6, 2026 10:23
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 6, 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-09-06T10:26:01.758488Z 384dea7 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.

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Deterministic PR hygiene checks passed.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 384dea7e71

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Les chaînes de repli propres à un rôle doivent résider dans la configuration d’opencodex. L’ajout de `model_fallback` dans `$CODEX_HOME/agents/*.toml` amène Codex 0.146+ à rejeter le fichier de rôle entier à cause de ce champ inconnu, puis à ignorer le rôle (#1190). Une ancienne ligne `model_fallback` dans le fichier TOML reste lue par souci de rétrocompatibilité, mais `ocx doctor` la signale.

opencodex ignore les candidats désactivés, non routables, en mauvais état, en période de temporisation ou ayant atteint le seuil de quota. L’instantané de disponibilité est mis en cache pendant `subagentModelFallbackPollMs`. Les tâches enfants chiffrées limitent la chaîne aux cibles ChatGPT natives canoniques et aux routes Responses directes avec authentification par clé explicitement approuvées via `allowEncryptedV2AgentTasks: true` ; si aucune ne peut consommer la charge chiffrée, la requête échoue au lieu d’envoyer un texte chiffré illisible à une autre destination. Un combo essaie d’abord une cible native canonique disponible ; si aucune n’est sélectionnable et que `agentTaskRecovery` est activé, un `NEW_TASK` chiffré est récupéré une fois avant l’envoi routé du combo.
opencodex ignore les candidats désactivés, non routables, en mauvais état, en période de temporisation ou ayant atteint le seuil de quota. L’instantané de disponibilité est mis en cache pendant `subagentModelFallbackPollMs`. Les tâches enfants chiffrées limitent la chaîne aux cibles ChatGPT natives canoniques et aux routes Responses directes avec authentification par clé explicitement approuvées via `allowEncryptedV2AgentTasks: true` ; si aucune ne peut consommer la charge chiffrée et que la récupération facultative ne permet pas un envoi routé, la requête échoue sans transmettre de texte chiffré illisible. Un combo essaie d’abord une cible native canonique disponible ; si aucune n’est sélectionnable ou si les tentatives natives sont épuisées, et que `agentTaskRecovery` est activé, un `NEW_TASK` chiffré est récupéré une fois avant l’envoi routé du combo.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Update the canonical English recovery description

Update the canonical English reference alongside these translations: this changed paragraph now says recovery may run after native attempts are exhausted, while docs-site/src/content/docs/reference/configuration/agents.md:119-122 still says the request fails when no target can consume the ciphertext and limits recovery to cases where no native target is selectable. As a result, the canonical page documents behavior that conflicts with both the changed translations and the updated English guide.

AGENTS.md reference: docs-site/AGENTS.md:L7-L10

Useful? React with 👍 / 👎.

@lidge-jun

Copy link
Copy Markdown
Owner Author

Exact-head Cross-platform CI 34026723367 completed SUCCESS on 384dea7 (docs aggregate ci). After #3762 merge, this PR base is current dev; head preserved with no rebase. Maintainer-integration choice: admin merge into current dev after assert-mergeable-review.sh --maintainer-integration 3763; no branch delete. Codex P2 locale-consistency comment on French agents.md vs English reference is not a runtime/security finding and is not silently resolved here.

@lidge-jun
lidge-jun merged commit c8470ef into dev Sep 6, 2026
23 of 27 checks passed
@lidge-jun
lidge-jun deleted the codex/release-244-recovery-doc-alignment-07c0 branch September 6, 2026 10:28
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 6, 2026
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.

1 participant