Skip to content

docs: declare native web search support in Codex examples - #2516

Open
solid-pixel wants to merge 1 commit into
Soju06:mainfrom
solid-pixel:codex/document-native-web-search
Open

solid-pixel wants to merge 1 commit into
Soju06:mainfrom
solid-pixel:codex/document-native-web-search

Conversation

@solid-pixel

Copy link
Copy Markdown

Summary

The Codex examples omit the provider capability needed to expose standalone web search with supported custom-provider setups. Add supports_standalone_web_search = true to all five ordinary codex-lb provider blocks across the English and Chinese READMEs, client setup guide, and downloadable configuration, with a codex-lb >= 1.22.0 note.

Closes #2498

Type of change

  • docs: — documentation only

OpenSpec

  • Not applicable — docs / CI / chore only

Documents existing endpoint support. The setup explanation links to the existing Responses compatibility specification; no proxy runtime or protocol changes.

Changes

  • Keep README edits to one configuration line each; translate the minimum-version comment in the Chinese README.
  • Explain the provider capability, live-search mode, and distinction from the experimental feature flag in docs/client-setup.md.
  • Preserve all other configuration values, including the separate Daybreak provider, which does not use the ordinary control-route path.

Test plan

  • mkdocs build --strict: passed using a temporary environment with the project's mkdocs-material>=9.6 documentation dependency.
  • Python tomllib: parsed the TOML snippets and downloadable configuration in all four changed files; verified all five ordinary provider blocks enable search and every other parsed value matches the base revision.
  • git diff --check: passed.
  • Runtime tests and the full application CI suite were not run for this documentation-only change.

Coordination

#2312 was still open and unmerged when this branch was published. This PR is based on current main and leaves model selections unchanged.

Checklist

  • Title follows Conventional Commits.
  • Linked the related issue.
  • Reviewed simplicity gates P1–P6: this documents an existing Codex client setting; no new server setting, README section, dashboard item, or runtime default.
  • CHANGELOG is not edited by hand.

@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Soju06/codex-lb/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: cab0395f-8e35-4546-b97a-8ad5fdb85b75

📥 Commits

Reviewing files that changed from the base of the PR and between 4dcf8f7 and be82dbe.

📒 Files selected for processing (4)
  • README.md
  • README.zh-CN.md
  • docs/client-setup.md
  • docs/examples/codex/config.toml

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


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated Codex CLI setup examples to enable standalone web search.
    • Added guidance on version and compatibility requirements, plus options for enabling search for a single session or persistently.

Walkthrough

Codex provider examples now enable standalone web search. The setup guide describes the minimum codex-lb version, how to request live search, and the separate experimental feature flag and support requirements.

Changes

Codex Web Search Documentation

Layer / File(s) Summary
Configure standalone web search
docs/client-setup.md, docs/examples/codex/config.toml, README.md, README.zh-CN.md
The provider examples enable standalone web search. The setup guide documents the codex-lb 1.22.0 minimum, the --search and web_search = "live" options, the separate experimental feature flag, and Codex and model support requirements.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other · Severity of issue fixed: Medium

Suggested reviewers: mastertyko

Merge Risk: ⚪ Minimal · up to be82d

This change updates Codex setup examples and guidance without establishing a runtime risk. No concrete issue remains that should block merging.

Architecture Summary

Architecture risk: 🔵 Low · up to be82d

The change affects 3 systems.

Changed systems: docs, README.md, README.zh-CN.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 2 changed files map to changed impact.
  • observed — README.md (service) was modified; 1 changed file maps to changed impact.
  • observed — README.zh-CN.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: The Codex CLI example adds supports_standalone_web_search = true and notes the minimum codex-lb version requirement of 1.22.0.
  • observed — Modified behavior in README.zh-CN.md: Codex CLI 配置新增独立网页搜索支持开关,并注明需要 codex-lb ≥ 1.22.0。
  • observed — Modified behavior in docs/client-setup.md: The standard Codex provider example adds supports_standalone_web_search = true. New documentation describes the version requirement, the provider capability’s default of false, session and persistent ways to request live search, and the separate experimental feature flag and Codex/model support requirements.
  • observed — Modified behavior in docs/client-setup.md: The API-key-authenticated Codex provider example adds supports_standalone_web_search = true, with a codex-lb 1.22.0 minimum noted.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation change to declare native web search support in Codex examples.
Description check ✅ Passed The description is directly related to the documentation changes and explains the new capability setting, version requirement, supported examples, validation steps, and scope.
Linked Issues check ✅ Passed Issue #2498 requires the Codex provider examples to declare supports_standalone_web_search = true, explain search-mode selection, distinguish the setting from [features].standalone_web_search, and…
Out of Scope Changes check ✅ Passed The changed files are documentation and a downloadable Codex configuration example. Each change adds or explains the provider capability required by issue #2498. The Chinese README, authenticated setu…
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…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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 Sep 28, 2026
Frozen811 added a commit to Frozen811/codex-lb that referenced this pull request Sep 29, 2026
…, Soju06#2498), cover scim/overflow merge convergence (Soju06#2518), harden model source usage and telemetry (Soju06#2521)

This branch has not been deployed

No deployments
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.

docs: add supports_standalone_web_search to the Codex provider example

1 participant