From 737654923f5b3d77f17ce2ae56076263a0739f2c Mon Sep 17 00:00:00 2001 From: Ahmed Ibrahim Date: Mon, 26 Jan 2026 17:51:23 -0800 Subject: [PATCH] remove/docs/reference --- codex-rs/README.md | 8 ++++---- codex-rs/config.md | 3 +-- codex-rs/core/src/codex.rs | 2 +- codex-rs/core/tests/suite/deprecation_notice.rs | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/codex-rs/README.md b/codex-rs/README.md index 5790425957..da77ee1ddd 100644 --- a/codex-rs/README.md +++ b/codex-rs/README.md @@ -16,7 +16,7 @@ You can also install via Homebrew (`brew install --cask codex`) or download a pl ## Documentation quickstart - First run with Codex? Start with the [Getting Started guide](https://developers.openai.com/codex/getting-started/overview) (links to the walkthrough for prompts, keyboard shortcuts, and session management). -- Want deeper control? See [Configuration documentation](https://developers.openai.com/codex/configuration/config-file). +- Want deeper control? See [Configuration documentation](https://developers.openai.com/codex/config-advanced/). ## What's new in the Rust CLI @@ -24,13 +24,13 @@ The Rust implementation is now the maintained Codex CLI and serves as the defaul ### Config -Codex supports a rich set of configuration options. Note that the Rust CLI uses `config.toml` instead of `config.json`. See [Configuration documentation](https://developers.openai.com/codex/configuration/config-file) for details. +Codex supports a rich set of configuration options. Note that the Rust CLI uses `config.toml` instead of `config.json`. See [Configuration documentation](https://developers.openai.com/codex/config-advanced/) for details. ### Model Context Protocol Support #### MCP client -Codex CLI functions as an MCP client that allows the Codex CLI and IDE extension to connect to MCP servers on startup. See the [configuration documentation](https://developers.openai.com/codex/configuration/config-file#connecting-to-mcp-servers) for details. +Codex CLI functions as an MCP client that allows the Codex CLI and IDE extension to connect to MCP servers on startup. See the [configuration documentation](https://developers.openai.com/codex/config-advanced/) for details. #### MCP server (experimental) @@ -46,7 +46,7 @@ Use `codex mcp` to add/list/get/remove MCP server launchers defined in `config.t ### Notifications -You can enable notifications by configuring a script that is run whenever the agent finishes a turn. The [notify documentation](https://developers.openai.com/codex/configuration/config-file#notify) includes a detailed example that explains how to get desktop notifications via [terminal-notifier](https://github.com/julienXX/terminal-notifier) on macOS. When Codex detects that it is running under WSL 2 inside Windows Terminal (`WT_SESSION` is set), the TUI automatically falls back to native Windows toast notifications so approval prompts and completed turns surface even though Windows Terminal does not implement OSC 9. +You can enable notifications by configuring a script that is run whenever the agent finishes a turn. The [notify documentation](https://developers.openai.com/codex/config-advanced/#notifications) includes a detailed example that explains how to get desktop notifications via [terminal-notifier](https://github.com/julienXX/terminal-notifier) on macOS. When Codex detects that it is running under WSL 2 inside Windows Terminal (`WT_SESSION` is set), the TUI automatically falls back to native Windows toast notifications so approval prompts and completed turns surface even though Windows Terminal does not implement OSC 9. ### `codex exec` to run Codex programmatically/non-interactively diff --git a/codex-rs/config.md b/codex-rs/config.md index 035519ea0e..be91ced788 100644 --- a/codex-rs/config.md +++ b/codex-rs/config.md @@ -2,5 +2,4 @@ This file has moved. Please see the latest configuration documentation here: -- Full config docs: https://developers.openai.com/codex/configuration/config-file -- MCP servers section: https://developers.openai.com/codex/configuration/config-file#connecting-to-mcp-servers +- Configuration documentation: https://developers.openai.com/codex/config-advanced/ diff --git a/codex-rs/core/src/codex.rs b/codex-rs/core/src/codex.rs index 1c4efd41b0..fee87cc1a9 100644 --- a/codex-rs/core/src/codex.rs +++ b/codex-rs/core/src/codex.rs @@ -732,7 +732,7 @@ impl Session { None } else { Some(format!( - "Enable it with `--enable {canonical}` or `[features].{canonical}` in config.toml. See https://developers.openai.com/codex/configuration/config-file#feature-flags for details." + "Enable it with `--enable {canonical}` or `[features].{canonical}` in config.toml. See https://developers.openai.com/codex/config-advanced/ for details." )) }; post_session_configured_events.push(Event { diff --git a/codex-rs/core/tests/suite/deprecation_notice.rs b/codex-rs/core/tests/suite/deprecation_notice.rs index bec6b67d88..83ff7bba0e 100644 --- a/codex-rs/core/tests/suite/deprecation_notice.rs +++ b/codex-rs/core/tests/suite/deprecation_notice.rs @@ -49,7 +49,7 @@ async fn emits_deprecation_notice_for_legacy_feature_flag() -> anyhow::Result<() assert_eq!( details.as_deref(), Some( - "Enable it with `--enable unified_exec` or `[features].unified_exec` in config.toml. See https://developers.openai.com/codex/configuration/config-file#feature-flags for details." + "Enable it with `--enable unified_exec` or `[features].unified_exec` in config.toml. See https://developers.openai.com/codex/config-advanced/ for details." ), );