Skip to content

fix(codex): size usage-guide tabs to content and align setup examples - #2672

Merged
llc1123 merged 2 commits into
looplj:unstablefrom
llc1123:fix/codex-usage-example
Oct 14, 2026
Merged

llc1123 merged 2 commits into
looplj:unstablefrom
llc1123:fix/codex-usage-example

Conversation

@llc1123

@llc1123 llc1123 commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Two small changes to the Codex compatibility surface:

  1. API key usage example (frontend/src/features/apikeys/components/apikeys-view-dialog.tsx)

    • Tab triggers no longer use a fixed equal-width grid; they size to their content and the tab list scrolls horizontally when space is tight, so the longest label ("Codex native compatibility") no longer overflows its button.
    • Increased spacing between tab triggers.
    • Restored the full ${HOME}/.codex/config.toml and ${HOME}/.codex/auth.json paths in the Codex example so readers know where each snippet belongs, and labeled the environment-variable block with the shell it runs in.
    • The CODEX_AUTHAPI_BASE_URL block is now explicit about being an environment variable (macOS/Linux export, plus a note that Windows users set it through System Environment Variables).
  2. Codex integration guide (docs/en/guides/codex-integration.md, docs/zh/guides/codex-integration.md)

    • auth.json sets the API key in both personal_access_token and OPENAI_API_KEY; keeping both fields is an API-key fallback across Codex client versions.
    • Default model updated to gpt-6.1-sol.
    • Base URL examples use a generic placeholder host and tell readers to substitute their own AxonHub address.
    • Environment variable step covers macOS/Linux and Windows.

Notes

  • No production endpoint or credentials are included; all host examples are placeholders.
  • The removed suppress_unstable_features_warning line is intentional: the example now follows the canonical config snippet.

Verification

  • eslint on the changed component: 0 errors (1 pre-existing react-hooks/exhaustive-deps warning for currentOrigin, unchanged by this PR).
  • prettier --check on all three changed files: pass.
  • Deployed and exercised the built frontend on Cloud Run; the page loads without console errors.

Sisyphus — oh-my-openagent

Summary by CodeRabbit

  • Documentation
    • Updated Codex setup guides with revised authentication, model, and endpoint examples.
    • Added separate environment-variable instructions for macOS/Linux and Windows, and clarified that a separate catalog URL is not needed.
  • Improvements
    • Updated the Codex compatibility example in the API key dialog with the latest configuration steps and Windows guidance.
    • Made the example tabs horizontally scrollable with fixed-width labels.

llc1123 and others added 2 commits October 14, 2026 18:29
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b9c42278-01bc-4d3d-aeec-ddc2cc64c53d
📥 Commits

Reviewing files that changed from the base of the PR and between f7e6023 and ac101f0.

📒 Files selected for processing: 3
  • docs/en/guides/codex-integration.md
  • docs/zh/guides/codex-integration.md
  • frontend/src/features/apikeys/components/apikeys-view-dialog.tsx

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 4 remain after this review.

📝 Walkthrough

Codex setup examples in the English and Chinese guides and API-key dialog now show updated authentication, model, endpoint, and environment-variable instructions. The dialog’s example tabs use a horizontally scrollable layout.

Changes: Codex setup examples

Layer / File(s) Summary
Update Codex setup examples
docs/en/guides/codex-integration.md, docs/zh/guides/codex-integration.md, frontend/src/features/apikeys/components/apikeys-view-dialog.tsx
The examples add OPENAI_API_KEY, use model gpt-6.1-sol, and update /codex endpoint and environment-variable instructions. The dialog replaces shell commands with file-editing instructions and uses horizontally scrollable tabs.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Suggested reviewers: looplj

Merge Risk: ⚪ Minimal · up to ac101

The Codex setup examples and dialog layout are updated, with no demonstrated authentication failure or other concrete risk that should block merging.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (2 skipped: 2 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the two main changes: sizing the Codex usage-guide tabs to their content and aligning the setup examples.
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.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (2 skipped: 2 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@greptile-apps

greptile-apps Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 4/5

[Low impact] Updates documentation and setup examples for Codex integration.

The PR appears safe to merge, with a non-blocking improvement to the copied Codex setup example.

Findings

  1. P2 Copied setup needs manual splitting ▶

Summary

The PR makes usage-guide tabs size to their labels and updates the English, Chinese, and frontend Codex examples.

  • Usage-example tabs keep their label widths and scroll when needed.
  • Codex examples show where each setting belongs and how to set it.

Acknowledgment: llc1123 explicitly states that removing suppress_unstable_features_warning is intentional because the example follows the canonical configuration.

Reviews (1) · Last reviewed commit: "docs(codex): align compatibility setup e..." · Reviewed by Greptile

Comment on lines +175 to +179
# \${HOME}/.codex/auth.json
{
"personal_access_token": "${apiKey}",
"OPENAI_API_KEY": "${apiKey}"
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Copied setup needs manual splitting

The new raw auth.json object shares one copy button with config.toml settings and shell commands. Users must now split the copied text themselves; the removed shell commands previously wrote the authentication file for them. Give each file and the shell command a separate code block and copy button, or keep shell commands that write the files.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is okay.

@llc1123
llc1123 merged commit aec4eff into looplj:unstable Oct 14, 2026
7 checks passed
Edint386 pushed a commit to Edint386/axonhub that referenced this pull request Oct 14, 2026
…looplj#2672)

* fix(apikeys): make Codex usage tabs fit their content

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>

* docs(codex): align compatibility setup examples

Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent)

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>

---------

Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant