Skip to content

docs: fix Codex model config in usage-doc#545

Merged
ding113 merged 2 commits intodevfrom
docs/fix-usage-doc-codex-model-542
Jan 5, 2026
Merged

docs: fix Codex model config in usage-doc#545
ding113 merged 2 commits intodevfrom
docs/fix-usage-doc-codex-model-542

Conversation

@ding113
Copy link
Owner

@ding113 ding113 commented Jan 5, 2026

Fix the Codex provider config examples in usage-doc:

  • Change model from "gpt-5.2-codex" to "gpt-5.2"
  • Keep model_reasoning_effort = "xhigh"

This avoids 400 invalid_request_error caused by unsupported reasoning effort when using gpt-5.2-codex.

Also includes a tiny Biome formatting fix in one unit test file (trailing blank line) to keep lint green.

Closes #542

Greptile Summary

Fixes incorrect Codex model configuration in usage documentation by changing model = "gpt-5.2-codex" to model = "gpt-5.2" in two configuration examples. This prevents 400 invalid_request_error when using model_reasoning_effort = "xhigh" with the Codex model, as gpt-5.2-codex only supports reasoning_effort = "medium". Also includes a minor Biome formatting fix (removed trailing blank line) in a test file.

Key Changes:

  • Updated both auth.json and environment variable configuration examples for Codex provider
  • Kept model_reasoning_effort = "xhigh" intact as it works correctly with gpt-5.2
  • Formatting fix aligns with project's Biome linting rules

This documentation fix complements the error rule added in #544 that handles this specific error scenario.

Confidence Score: 5/5

  • This PR is completely safe to merge with no risk
  • Simple documentation fix that corrects a known configuration error, changes are minimal and well-isolated, formatting fix is trivial
  • No files require special attention

Important Files Changed

Filename Overview
src/app/[locale]/usage-doc/page.tsx Fixed Codex model config from "gpt-5.2-codex" to "gpt-5.2" in two locations to avoid reasoning effort errors

Sequence Diagram

sequenceDiagram
    participant User
    participant UsageDoc as Usage Doc Page
    participant CodeBlock as Code Block Component
    participant UserConfig as User's config.toml

    Note over User,UserConfig: Before Fix: Incorrect Configuration
    User->>UsageDoc: View Codex configuration examples
    UsageDoc->>CodeBlock: Display model = "gpt-5.2-codex"<br/>with model_reasoning_effort = "xhigh"
    User->>UserConfig: Copy configuration
    UserConfig-->>User: 400 invalid_request_error:<br/>Unsupported reasoning effort

    Note over User,UserConfig: After Fix: Correct Configuration
    User->>UsageDoc: View Codex configuration examples
    UsageDoc->>CodeBlock: Display model = "gpt-5.2"<br/>with model_reasoning_effort = "xhigh"
    User->>UserConfig: Copy corrected configuration
    UserConfig-->>User: ✓ Configuration works correctly
Loading

@coderabbitai
Copy link

coderabbitai bot commented Jan 5, 2026

📝 Walkthrough

Walkthrough

PR更新了使用文档中的模型配置示例,将两个TOML代码块的模型值从"gpt-5.2-codex"改为"gpt-5.2",并移除了测试文件中的尾部空行。

Changes

群组 / 文件 变更摘要
文档配置更新
src/app/[locale]/usage-doc/page.tsx
将两个TOML代码块中的模型配置从"gpt-5.2-codex"替换为"gpt-5.2",以修正错误的Codex供应商配置示例
测试文件格式清理
tests/unit/repository/system-config-update-missing-columns.test.ts
移除describe块后的尾部空行

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed PR标题准确地反映了主要变更:修复usage-doc中的Codex模型配置,将"gpt-5.2-codex"改为"gpt-5.2"。
Description check ✅ Passed PR描述详细说明了变更内容,包括模型配置修改、原因(避免400错误)以及额外的Biome格式修复,与实际代码变更相符。
Linked Issues check ✅ Passed PR完全满足issue #542的要求:在usage-doc中将model从"gpt-5.2-codex"改为"gpt-5.2",保留model_reasoning_effort = "xhigh",解决了400错误问题。
Out of Scope Changes check ✅ Passed 所有变更均在范围内:修改usage-doc中的两个TOML代码块以修复Codex配置,加上一个单元测试文件的Biome格式修复,都与issue #542的目标相关。
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/fix-usage-doc-codex-model-542

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to Reviews > Disable Cache setting

📥 Commits

Reviewing files that changed from the base of the PR and between f58d824 and 599a301.

📒 Files selected for processing (2)
  • src/app/[locale]/usage-doc/page.tsx
  • tests/unit/repository/system-config-update-missing-columns.test.ts
💤 Files with no reviewable changes (1)
  • tests/unit/repository/system-config-update-missing-columns.test.ts
🧰 Additional context used
📓 Path-based instructions (5)
**/*.{ts,tsx,js,jsx,json}

📄 CodeRabbit inference engine (CLAUDE.md)

Use 2-space indentation in all code files

Files:

  • src/app/[locale]/usage-doc/page.tsx
**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.{ts,tsx,js,jsx}: Use double quotes for strings instead of single quotes
Use trailing commas in multi-line structures
Enforce maximum line length of 100 characters
Use path alias @/* to reference files from ./src/* directory

**/*.{ts,tsx,js,jsx}: Use Biome for linting and formatting with 2-space indent, double quotes, trailing commas, and 100 character max line length
Use path alias @/* to reference files in ./src/* directory

Files:

  • src/app/[locale]/usage-doc/page.tsx
src/**/*.{tsx,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

src/**/*.{tsx,jsx}: Use lucide-react for icons, no custom SVGs
Use React's automatic escaping to prevent XSS vulnerabilities

Files:

  • src/app/[locale]/usage-doc/page.tsx
**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

**/*.{ts,tsx}: Use TypeScript strict mode for type safety
Use readonly or const assertions for immutable data structures

Files:

  • src/app/[locale]/usage-doc/page.tsx
**/*.{tsx,json}

📄 CodeRabbit inference engine (AGENTS.md)

Use next-intl for internationalization with 5 locales: en, ja, ru, zh-CN, zh-TW

Files:

  • src/app/[locale]/usage-doc/page.tsx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
  • GitHub Check: Greptile Review
  • GitHub Check: pr-description
  • GitHub Check: 🌐 API Tests
  • GitHub Check: check-codex-status
  • GitHub Check: Docker Build Test
  • GitHub Check: pr-label
  • GitHub Check: pr-review
  • GitHub Check: dev-build-deploy
🔇 Additional comments (1)
src/app/[locale]/usage-doc/page.tsx (1)

642-642: 模型配置更新正确且完整。

模型名称从 "gpt-5.2-codex" 改为 "gpt-5.2",并保留了 model_reasoning_effort = "xhigh"。GPT-5.2 支持该推理级别,两处配置(auth-json 和 env-var)更新一致,代码库中不存在对旧模型名称的残留引用。


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

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ding113, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily addresses an issue in the usage documentation where an outdated model name for the Codex provider was causing configuration errors. The change updates the model name in the documentation examples to ensure they are correct and functional. Additionally, a small formatting adjustment was made in a test file to align with code style guidelines.

Highlights

  • Documentation Fix: Corrected the Codex model configuration examples in the usage documentation by changing the model name from "gpt-5.2-codex" to "gpt-5.2" to prevent 400 invalid_request_error.
  • Code Formatting: Applied a minor Biome formatting fix in a unit test file by removing a trailing blank line to maintain linting standards.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions github-actions bot added the size/XS Extra Small PR (< 50 lines) label Jan 5, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request delivers two targeted fixes. The primary change updates the Codex model name in the usage documentation from gpt-5.2-codex to gpt-5.2. As noted in the description, this is a necessary correction to prevent errors when using a high reasoning effort, thereby improving the accuracy and usability of the documentation. The second change is a minor formatting adjustment in a test file to resolve a linting issue. Both changes are correct and improve the project's quality. The pull request is well-scoped and ready for merging.

@github-actions github-actions bot added bug Something isn't working area:docs area:UI labels Jan 5, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

🧪 测试结果

测试类型 状态
代码质量
单元测试
集成测试
API 测试

总体结果: ✅ 所有测试通过

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Code Review Summary

No significant issues identified in this PR.

PR Size: XS

  • Lines changed: 5
  • Files changed: 2

Review Coverage

  • Logic and correctness - Clean
  • Security (OWASP Top 10) - Clean
  • Error handling - Clean
  • Type safety - Clean
  • Documentation accuracy - Clean
  • Test coverage - Adequate
  • Code clarity - Good

Automated review by Codex AI

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

  • Identified and reviewed PR #545 (docs: fix Codex model config in usage-doc).
  • Applied PR size label: size/XS (5 lines changed, 2 files).
  • No diff-line issues met the >=80 confidence reporting threshold, so no inline comments were posted.
  • Submitted the “No significant issues” review summary via gh pr review.

@ding113 ding113 merged commit cd627f6 into dev Jan 5, 2026
18 checks passed
@github-project-automation github-project-automation bot moved this from Backlog to Done in Claude Code Hub Roadmap Jan 5, 2026
This was referenced Jan 6, 2026
@coderabbitai coderabbitai bot mentioned this pull request Jan 10, 2026
5 tasks
@ding113 ding113 deleted the docs/fix-usage-doc-codex-model-542 branch January 27, 2026 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs area:UI bug Something isn't working size/XS Extra Small PR (< 50 lines)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant