docs: refresh settings reference#305
docs: refresh settings reference#305ndycode wants to merge 2 commits intodocs/pr7-maintainer-runbooks-latestfrom
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
|
Important Review skippedAuto reviews are limited based on label configuration. 🚫 Review skipped — only excluded labels are configured. (1)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
Summary
docs/reference/settings.mdinto a structured settings reference with defaults and effectsValidation
npm run test -- test/documentation.test.tsnote: greptile review for oc-chatgpt-multi-auth. cite files like
lib/foo.ts:123. confirm regression tests + windows concurrency/token redaction coverage.Greptile Summary
this pr rewrites
docs/reference/settings.mdfrom a loose bullet-list inventory into a structured reference with per-key defaults and effect descriptions, split acrossdashboardDisplaySettings(account list view, summary line, menu behavior, color theme) andpluginConfig(backend controls), with stable vs. advanced env overrides clearly separated.changes
| key | default | effect |tablesmenuShowFetchStatusno longer duplicated across account list view and menu behavior (previous review concern addressed)---rule between themissues found
account list viewandsummary linesections still carry their original bullet-key lists directly above the new tables — every other section drops the bullets; these two are inconsistent and the lists are fully redundant with the tablesretryAllAccountsMaxRetriesdefault is documented asInfinity, which is not a valid json literal; users copying this intosettings.jsonwill get a parse error — needs to be quoted or replaced with the actual sentinel value the runtime acceptsretryAllAccountsMaxWaitMs: 0is ambiguous: without knowing whether0disables the cap or means zero-millisecond delay, the two combined defaults (maxWaitMs: 0,maxRetries: Infinity) look like a potential tight-retry loop to anyone reading the table coldtest/documentation.test.tsalready covers docs parity; consider asserting that the defaults documented here match the runtime defaults inplugin-config.ts/dashboard-settings.tsConfidence Score: 4/5
Infinityjson validity issue; the other two are clean-up suggestionsInfinitydefault is the only issue that could actively mislead a user editingsettings.jsondirectly; fixing that (or confirming the runtime accepts the string) unblocks merge. redundant bullet lists and themaxWaitMs: 0ambiguity are p2 cleanups that don't block anything.retryAllAccountsMaxRetriesdefault value is valid json or document the string form explicitlyImportant Files Changed
Infinityis not valid JSON for a settings.json default, andretryAllAccountsMaxWaitMs: 0semantics are ambiguousFlowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["~/.codex/multi-auth/settings.json"] --> B{"top-level key?"} B -->|dashboardDisplaySettings| C[Account List View] B -->|dashboardDisplaySettings| D[Summary Line] B -->|dashboardDisplaySettings| E[Menu Behavior] B -->|dashboardDisplaySettings| F[Color Theme] B -->|pluginConfig| G[Session & Sync] B -->|pluginConfig| H[Rotation & Quota] B -->|pluginConfig| I[Refresh & Recovery] B -->|pluginConfig| J[Performance & Timeouts] K["env overrides (stable)"] -->|CODEX_MULTI_AUTH_DIR etc.| A L["env overrides (advanced)"] -->|CODEX_MULTI_AUTH_BYPASS etc.| A C & D & E & F --> M["TUI / settings-hub.ts"] G & H & I & J --> MPrompt To Fix All With AI
Last reviewed commit: "Deduplicate settings..."