Fix documentation inconsistency #1132 #1141
Closed
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.
Documentation: Clarify instruction file usage and resolve README inconsistencies (#1132)
This update resolves inconsistencies between
README.mdandexamples/prompting_guide.mdrelated to instruction file names and expected locations.Changes
README.mdto correctly reference~/.codex/instructions.mdinstead of the outdated~/.codex/AGENTS.md, aligning with actual CLI behavior.AGENTS.mdas the preferred file for project-specific instructions across bothREADME.mdandexamples/prompting_guide.md.CODEX.md,codex.md, and.codex.mdare still supported for backward compatibility, butAGENTS.mdis recommended for new projects.--no-project-docflag description insrc/cli.tsxto reflect support for multiple project documentation file names (e.g.,AGENTS.md,CODEX.md, etc.).These changes improve clarity and ensure the documentation reflects the current behavior of the CLI.