docs: add example config.toml #5175
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…one was slower. I had GPT-5 scan the codebase for every accepted config key, check the defaults, and generate a single example config.toml with annotations. It lists all keys Codex reads from TOML, sets each to its effective default where it exists, leaves optional ones commented, and adds short comments on purpose and valid values. This should make onboarding faster and reduce configuration errors. I can rename it to config.example.toml or move it under docs/ if you prefer.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was missing an example config.toml, and following docs/config.md alone was slower. I had GPT-5 scan the codebase for every accepted config key, check the defaults, and generate a single example config.toml with annotations. It lists all keys Codex reads from TOML, sets each to its effective default where it exists, leaves optional ones commented, and adds short comments on purpose and valid values. This should make onboarding faster and reduce configuration errors. I can rename it to config.example.toml or move it under docs/ if you prefer.