Skip to content

docs: clarify Codex --config flag placement#338

Open
dagardner-nv wants to merge 2 commits into
NVIDIA:mainfrom
dagardner-nv:david-document-codex-config
Open

docs: clarify Codex --config flag placement#338
dagardner-nv wants to merge 2 commits into
NVIDIA:mainfrom
dagardner-nv:david-document-codex-config

Conversation

@dagardner-nv

@dagardner-nv dagardner-nv commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Overview

Add a warning to docs/nemo-relay-cli/codex.mdx about the placement of the --config flag

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.
  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Details

  • Add a warning to docs/nemo-relay-cli/codex.mdx about the placement of the --config flag
  • Add .nemo-relay to .gitignore

Where should the reviewer start?

Start with docs/nemo-relay-cli/codex.mdx, especially the warning following the dry-run example.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Relates to: none

Summary by CodeRabbit

  • Documentation
    • Clarified guidance for running Codex through Relay, including where --config overrides should be placed and how override precedence works.
  • Chores
    • Updated ignore rules to exclude the Relay local state directory from version control.

Signed-off-by: David Gardner <dagardner@nvidia.com>
Signed-off-by: David Gardner <dagardner@nvidia.com>
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Adds a "Relay" section to .gitignore ignoring /.nemo-relay, and updates codex.mdx documentation with a warning that Codex --config overrides must precede the exec subcommand, explaining precedence between root-level and command-specific overrides.

Changes

Repo hygiene and docs

Layer / File(s) Summary
Gitignore entry and Codex docs warning
.gitignore, docs/nemo-relay-cli/codex.mdx
Adds /.nemo-relay ignore rule and documents that --config overrides placed after exec are command-scoped and take precedence over root-level Relay-provided overrides.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description includes the required overview, details, review start point, and checklist items, with only a minimal related-issue note.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title follows Conventional Commits and accurately summarizes the documentation change.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added size:S PR is small Documentation documentation-related labels Jun 30, 2026
@dagardner-nv dagardner-nv changed the title docs: clarify Codex config override placement docs: clarify Codex --config flag placement Jun 30, 2026
@dagardner-nv dagardner-nv marked this pull request as ready for review June 30, 2026 21:06
@dagardner-nv dagardner-nv requested review from a team and lvojtku as code owners June 30, 2026 21:06
@github-actions

Copy link
Copy Markdown

@willkill07 willkill07 added this to the 0.5 milestone Jun 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation documentation-related size:S PR is small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants