`docs/example-config.md`
What is the type of issue?
Documentation is incorrect
What is the issue?
https://github.com/openai/codex/blob/7c6a47958abe86590f131848a7af5fd2d4c69819/docs/example-config.md?plain=1#L137-L159
notify is a top-level key and it's placed under tui here. I don't understand how this vibe coded pr #5175 can be merged with no review for correctness
Where did you find it?
No response
This example config was recently contributed by a community member. If you'd like to contribute a documentation fix, I'd welcome a PR.
@etraut-openai i would suggest deleting the example toml if it's wrong. we have several sources of doc describing the config:
- https://developers.openai.com/codex/local-config/#personalizing-the-codex-ide-extension
- https://github.com/openai/codex/blob/7c6a47958abe86590f131848a7af5fd2d4c69819/docs/config.md
- https://github.com/openai/codex/blob/7c6a47958abe86590f131848a7af5fd2d4c69819/docs/example-config.md
- https://github.com/openai/codex/blob/ad7b9d63c326d5c92049abd16f9f5fb64a573a69/codex-rs/core/src/config/mod.rs docstring
the proper way is to keep sync with actual code. what do you think?
Yes, I agree that the codex documentation is a bit of a mess currently. We're going to be working to consolidate all documentation here over the next several weeks.