[docs] Update codex installation docs for clarity#1734
Open
bdotdub wants to merge 2 commits intogithub:mainfrom
Open
[docs] Update codex installation docs for clarity#1734bdotdub wants to merge 2 commits intogithub:mainfrom
bdotdub wants to merge 2 commits intogithub:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the clarity of the Codex installation documentation by removing a confusing comment that implied the PAT should be stored in the config file (when it's actually stored as an environment variable), and by making the PAT security instructions more prominent by converting them from a collapsible section to a standard heading.
Key changes:
- Removed misleading comment about replacing PAT in config file
- Promoted PAT security instructions from collapsible details to a visible section heading
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The codex installation docs were slightly confusing when I went through them. We're not actually storing the PAT in the config. As well, storing the PAT as an env var is a requirement so installation shouldn't be collapsed, where it is easily missed.
What changed
MCP impact
Security / limits
Tool renaming
deprecated_tool_aliases.goLint & tests
./script/lint./script/testDocs