From ee9d441777b81716a78cdd371bd78a2cccaa7855 Mon Sep 17 00:00:00 2001 From: Thibault Sottiaux Date: Sat, 3 Jan 2026 02:19:52 -0800 Subject: [PATCH] chore: update outdated docs (#8701) --- codex-rs/README.md | 6 +++--- docs/config.md | 12 ++++++++++++ docs/install.md | 6 +++--- justfile | 4 ---- 4 files changed, 18 insertions(+), 10 deletions(-) diff --git a/codex-rs/README.md b/codex-rs/README.md index a3d1b82fb8..cbe1fe3779 100644 --- a/codex-rs/README.md +++ b/codex-rs/README.md @@ -15,8 +15,8 @@ You can also install via Homebrew (`brew install --cask codex`) or download a pl ## Documentation quickstart -- First run with Codex? Follow the walkthrough in [`docs/getting-started.md`](../docs/getting-started.md) for prompts, keyboard shortcuts, and session management. -- Already shipping with Codex and want deeper control? Jump to [`docs/advanced.md`](../docs/advanced.md) and the configuration reference at [`docs/config.md`](../docs/config.md). +- First run with Codex? Start with [`docs/getting-started.md`](../docs/getting-started.md) (links to the walkthrough for prompts, keyboard shortcuts, and session management). +- Want deeper control? See [`docs/config.md`](../docs/config.md) and [`docs/install.md`](../docs/install.md). ## What's new in the Rust CLI @@ -30,7 +30,7 @@ Codex supports a rich set of configuration options. Note that the Rust CLI uses #### 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`](../docs/config.md#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`](../docs/config.md#connecting-to-mcp-servers) for details. #### MCP server (experimental) diff --git a/docs/config.md b/docs/config.md index 950a631fc5..2b64253d30 100644 --- a/docs/config.md +++ b/docs/config.md @@ -5,3 +5,15 @@ For basic configuration instructions, see [this documentation](https://developer For advanced configuration instructions, see [this documentation](https://developers.openai.com/codex/config-advanced). For a full configuration reference, see [this documentation](https://developers.openai.com/codex/config-reference). + +## Connecting to MCP servers + +Codex can connect to MCP servers configured in `~/.codex/config.toml`. See the configuration reference for the latest MCP server options: + +- https://developers.openai.com/codex/config-reference + +## Notify + +Codex can run a notification hook when the agent finishes a turn. See the configuration reference for the latest notification settings: + +- https://developers.openai.com/codex/config-reference diff --git a/docs/install.md b/docs/install.md index a9905144e3..20d8b54a54 100644 --- a/docs/install.md +++ b/docs/install.md @@ -26,7 +26,7 @@ rustup component add rustfmt rustup component add clippy # Install helper tools used by the workspace justfile: cargo install just -# Optional: install nextest for the `just test` helper (or use `cargo test --all-features` as a fallback) +# Optional: install nextest for the `just test` helper cargo install cargo-nextest # Build Codex. @@ -41,9 +41,9 @@ just fix -p # Run the relevant tests (project-specific is fastest), for example: cargo test -p codex-tui -# If you have cargo-nextest installed, `just test` runs the full suite: +# If you have cargo-nextest installed, `just test` runs the test suite via nextest: just test -# Otherwise, fall back to: +# If you specifically want the full `--all-features` matrix, use: cargo test --all-features ``` diff --git a/justfile b/justfile index 79b691e0a0..43ebae74aa 100644 --- a/justfile +++ b/justfile @@ -14,10 +14,6 @@ codex *args: exec *args: cargo run --bin codex -- exec "$@" -# `codex tui` -tui *args: - cargo run --bin codex -- tui "$@" - # Run the CLI version of the file-search crate. file-search *args: cargo run --bin codex-file-search -- "$@"