codex-rs/docs/protocol_v1.md appears stale
Open 💬 0 comments Opened Jun 1, 2026 by bar-d
What happened?
While reviewing the repo docs before considering a contribution, I noticed that codex-rs/docs/protocol_v1.md appears to be stale relative to the current protocol/core code.
A few examples:
- The opening sentence links to
../core/src/agent.rs, butcodex-rs/core/src/agent.rsno longer exists. TheCodexstruct currently lives incodex-rs/core/src/session/mod.rs, while agent-related code is undercodex-rs/core/src/agent/. - The session section refers to
Op::ConfigureSession, but I could not find aConfigureSessionvariant incodex-rs/protocol/src/protocol.rs. - The task/user input sections refer to
Op::UserTurnas the current input operation andOp::UserInputas legacy, but the currentOpenum definesUserInput. EventMsg::TurnCompleteis listed twice in the exampleEventMsgbullet list.- There are a few small prose/formatting issues, such as “These are entities exit on the codex backend”, “The Task executes to until”, “Has an string ID”, and the inline transport list under
## Transport.
Expected behavior
The protocol overview should either match the current codex-rs/protocol/src/protocol.rs and core session structure, or clearly identify which parts are historical/out-of-date. Internal links should resolve to existing files.
Additional context
I searched open issues and PRs for terms including protocol_v1, ConfigureSession, UserTurn, and core/src/agent.rs, and did not find an existing open issue that appears to cover this specific doc drift.