Commit 5687372
authored
docs: clarify Codex gateway config (NVIDIA#169)
#### Overview
Clarifies the standalone Codex gateway setup so users know where to add the
provider alias, when to restart Codex, and why existing local history may appear
hidden after switching providers.
- [x] I confirm this contribution is my own work, or I have the right to submit it under this project's license.
- [x] I searched existing issues and open pull requests, and this does not duplicate existing work.
#### Details
- Identifies `~/.codex/config.toml` as the file that should contain the
`nemo-relay-openai` provider alias.
- Adds a restart note for Codex GUI/app users and a new-process note for CLI
users.
- Documents that some Codex GUI/app versions scope visible history by active
provider configuration, with an upstream Codex issue link for context.
- Mirrors the guidance in both the Fern Codex CLI page and the coding-agent
integration README.
Validation:
- `just docs`
- commit-time pre-commit hooks, including docs markdown linkcheck
#### Where should the reviewer start?
Start with `docs/nemo-relay-cli/codex.mdx`, then compare the mirrored wording in
`integrations/coding-agents/codex/README.md`.
#### Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
- Closes RELAY-164
## Summary by CodeRabbit
* **Documentation**
* Enhanced Standalone Gateway setup instructions with improved clarity on local provider configuration.
* Added restart guidance for the application after saving provider configuration changes.
* Clarified conversation history behavior with different provider configurations.
[](https://app.coderabbit.ai/change-stack/NVIDIA/NeMo-Relay/pull/169?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)
Authors:
- Will Killian (https://github.com/willkill07)
Approvers:
- David Gardner (https://github.com/dagardner-nv)
URL: NVIDIA#1691 parent e1e90b3 commit 5687372
2 files changed
Lines changed: 30 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
100 | | - | |
101 | | - | |
| 100 | + | |
| 101 | + | |
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
| |||
111 | 111 | | |
112 | 112 | | |
113 | 113 | | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
114 | 128 | | |
115 | 129 | | |
116 | 130 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | | - | |
103 | | - | |
| 102 | + | |
| 103 | + | |
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
116 | 128 | | |
117 | 129 | | |
118 | 130 | | |
| |||
0 commit comments