docs(auth): align front-door flows with shipped workflows#109
docs(auth): align front-door flows with shipped workflows#109
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. |
📝 Walkthroughwalkthroughdocumentation-only update across changes
estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes missing items and risks:
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
📝 Coding Plan
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 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Updates public docs to match the shipped “front-door”/dashboard workflows (login → restore, settings split, sync preview, diagnostics), resurrecting the cleaned-up docs set from archived PR #80 while keeping the stack docs-only.
Changes:
- Documented backup restore prompt + manual restore manager entry points across landing pages and troubleshooting.
- Updated settings/commands references to reflect the shipped settings split and preview-first Codex CLI sync workflow.
- Expanded troubleshooting and feature map coverage for restore/sync/diagnostics flows.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/troubleshooting.md | Adds restore + sync troubleshooting sections and interactive diagnostics paths |
| docs/reference/settings.md | Aligns settings reference text with shipped menu structure and sync workflow notes |
| docs/reference/commands.md | Updates command descriptions and settings hotkeys/workflow entry points |
| docs/index.md | Updates docs landing page to mention restore/sync/diagnostics workflows |
| docs/getting-started.md | Adds “Restore or start fresh” plus settings/sync guidance |
| docs/features.md | Expands feature map for restore prompt/manager, sync center, and JSON diagnostics |
| docs/README.md | Updates docs portal index blurbs to match new workflows |
| README.md | Updates top-level README bullets and adds interactive dashboard paths/troubleshooting note |
Comments suppressed due to low confidence (1)
docs/reference/settings.md:1
- This list reads as if backup/rollback context is always available, but elsewhere (e.g., troubleshooting and later recommendations) backup support appears to be settings-dependent. Suggest explicitly noting here that rollback paths/context are shown only when storage backups are enabled, so users don’t expect
.bak/.walartifacts when backups are off.
# Settings Reference
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/reference/settings.md
Outdated
| @@ -72,9 +72,11 @@ Controls display style: | |||
|
|
|||
| ## Advanced and Operator Controls | |||
| `Codex CLI Sync` is a preview-first sync center for Codex CLI account sync. | ||
| See [upgrade notes](../upgrade.md) for sync workflow changes. | ||
|
|
||
| Before applying sync, it shows: |
docs/reference/settings.md
Outdated
|
|
||
| The advanced section includes a preview-first sync center for Codex CLI account sync. | ||
| `Codex CLI Sync` is a preview-first sync center for Codex CLI account sync. | ||
| See [upgrade notes](../upgrade.md) for sync workflow changes. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/reference/settings.md (1)
79-103:⚠️ Potential issue | 🟠 Majorupgrade-note and validation-script governance gap remains.
this section points readers to upgrade notes for sync workflow changes, but the upgrade doc was not updated in this pr. also, validation bullets should mention the full doc-change script set used here (including lint and the documentation test command) to keep release hygiene reproducible.
as per coding guidelines, “
docs/**: keep README, SECURITY, and docs consistent with actual CLI flags and workflows. whenever behavior changes, require updated upgrade notes and mention new npm scripts.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/settings.md` around lines 79 - 103, Update the upgrade notes and validation checklist to reflect the sync workflow changes introduced by "Codex CLI Sync": add or update the relevant section in upgrade.md with the new preview/apply/refresh and preservation behavior details, and expand the Validation bullets in docs/reference/settings.md (which currently list `npm run typecheck`, `npm run build`, `npm test`) to include the full doc-change script set used here (e.g., `npm run lint` and the documentation test command), and ensure README and SECURITY docs are kept consistent with the new CLI flags and workflows so upgrade-note governance is satisfied.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/reference/commands.md`:
- Line 23: Update the table row for the `codex auth login` entry to remove the
ambiguous phrase "diagnostics entry points" and rephrase it to explicitly say
this opens the interactive auth dashboard and provides dashboard paths and links
to diagnostics commands; locate and edit the `codex auth login` description
string so it reads something like "Open interactive auth dashboard, including
login, restore, settings, and dashboard paths and links to diagnostics
commands."
In `@docs/troubleshooting.md`:
- Around line 66-68: Update the troubleshooting table and adjacent text to cover
custom-root and Windows edge cases: note that backups may live in a custom data
root (e.g., when users set an app-specific data dir or XDG_DATA_HOME) instead of
~/.codex/multi-auth/backups/, and show the Windows path form (e.g.,
C:\Users\<User>\.codex\multi-auth\backups\) and how to locate the effective
backup directory (check environment/config for custom root or XDG_DATA_HOME, and
list the exact backup folder name used by the app); update the rows referencing
"You expected a restore prompt but went straight to OAuth" and "`Restore From
Backup` says no backups were found" to instruct users to verify the custom/root
path and Windows path before rerunning `codex auth login`, and add a short note
about running in an interactive terminal when confirming restore selection.
In `@README.md`:
- Line 247: Update the troubleshooting line to avoid the hardcoded
"~/.codex/multi-auth/backups/" by referencing the CODEX_MULTI_AUTH_DIR
environment variable (i.e., backups live under $CODEX_MULTI_AUTH_DIR/backups or
%CODEX_MULTI_AUTH_DIR%\backups on Windows), and add a Windows-friendly example
path; mention both Unix- and Windows-style examples and that the actual backup
location is derived from CODEX_MULTI_AUTH_DIR rather than a fixed home subpath.
---
Outside diff comments:
In `@docs/reference/settings.md`:
- Around line 79-103: Update the upgrade notes and validation checklist to
reflect the sync workflow changes introduced by "Codex CLI Sync": add or update
the relevant section in upgrade.md with the new preview/apply/refresh and
preservation behavior details, and expand the Validation bullets in
docs/reference/settings.md (which currently list `npm run typecheck`, `npm run
build`, `npm test`) to include the full doc-change script set used here (e.g.,
`npm run lint` and the documentation test command), and ensure README and
SECURITY docs are kept consistent with the new CLI flags and workflows so
upgrade-note governance is satisfied.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7f83888f-cf86-4215-b7a9-81f882d59530
📒 Files selected for processing (8)
README.mddocs/README.mddocs/features.mddocs/getting-started.mddocs/index.mddocs/reference/commands.mddocs/reference/settings.mddocs/troubleshooting.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Greptile Review
🧰 Additional context used
📓 Path-based instructions (1)
docs/**
⚙️ CodeRabbit configuration file
keep README, SECURITY, and docs consistent with actual CLI flags and workflows. whenever behavior changes, require updated upgrade notes and mention new npm scripts.
Files:
docs/reference/commands.mddocs/features.mddocs/getting-started.mddocs/index.mddocs/troubleshooting.mddocs/README.mddocs/reference/settings.md
🪛 LanguageTool
docs/getting-started.md
[style] ~77-~77: To make your writing flow more naturally, try moving the adverb ‘already’ closer to the verb ‘named’.
Context: ...rt Fresh Use the restore path when you already have named backup files and want to recover accoun...
(PERF_TENS_ADV_PLACEMENT)
🔇 Additional comments (7)
docs/features.md (1)
12-13: looks aligned with shipped flows.these additions are consistent with runtime behavior and improve front-door clarity for restore, diagnostics, and sync/settings paths. evidence aligns with session recovery and backup validation mechanics in
lib/recovery.ts:100andlib/named-backup-export.ts:170.Also applies to: 37-37, 59-60
README.md (1)
182-185: config source precedence docs are accurate.the new
CODEX_MULTI_AUTH_CONFIG_PATHnote matches both read and write paths in config handling (lib/config.ts:68,lib/config.ts:388).docs/getting-started.md (1)
75-95: good front-door sequencing and terminology.the added restore and sync/settings sections are clear and consistent with shipped dashboard flows.
docs/index.md (1)
3-3: index updates are coherent and useful.the added restore/sync/settings workflow summaries fit the daily-use landing page well.
Also applies to: 15-15, 44-49
docs/reference/commands.md (1)
94-99: hotkey/workflow pack additions look good.this is clearer for operators and matches the updated settings split and sync path language.
Also applies to: 104-113
docs/troubleshooting.md (1)
83-95: sync troubleshooting additions are strong.the symptom/action table and interactive diagnostics path are practical and actionable.
Also applies to: 118-122
docs/README.md (1)
20-27: portal parity improvements look good.the updated guide/reference focus text is aligned with current dashboard workflows and settings split docs.
Also applies to: 42-44
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/reference/settings.md (1)
79-96:⚠️ Potential issue | 🟡 Minoradd an upgrade-note entry for these workflow semantics.
line 79 to line 96 introduces concrete shipped sync/restore behavior framing. please add a matching note in
docs/upgrade.mdand state script impact (new npm scripts or explicitly none) so migration guidance stays complete.as per coding guidelines,
docs/**: keep README, SECURITY, and docs consistent with actual CLI flags and workflows. whenever behavior changes, require updated upgrade notes and mention new npm scripts.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/settings.md` around lines 79 - 96, Add an upgrade-note in docs/upgrade.md describing the shipped "Codex CLI Sync" workflow semantics introduced (mention "Codex CLI Sync", the preview list items, and the workflow commands: refresh and apply, and that sync is one-way and target-only accounts are preserved), and explicitly state the script impact (no new npm scripts were added or list any new scripts if they exist, e.g., npm run codex:sync), ensuring README and SECURITY docs are updated to remain consistent with the CLI flags and workflows; place the note under the appropriate version header and reference the refresh/apply commands and backup file names (.bak, .wal) so migration guidance is complete.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 185: Update the README description for CODEX_MULTI_AUTH_CONFIG_PATH to
state that when set it takes precedence and overrides the default config lookup
(i.e., it is checked first and used instead of the normal discovery), matching
the behavior implemented in lib/config.ts (see the logic around the env check in
lib/config.ts:47 and resolution in lib/config.ts:184); replace “alternate config
file source” with explicit wording that the env var overrides the default path
lookup.
- Line 214: Replace the incorrect experimental sync package name string
"oc-chatgpt-multi-auth" with the canonical package name "codex-multi-auth"
wherever it appears in the docs (the README reference and the storage-paths
reference tested by documentation.test.ts); ensure both occurrences are updated
to "codex-multi-auth" so naming is consistent with the front-door docs and the
tests.
---
Outside diff comments:
In `@docs/reference/settings.md`:
- Around line 79-96: Add an upgrade-note in docs/upgrade.md describing the
shipped "Codex CLI Sync" workflow semantics introduced (mention "Codex CLI
Sync", the preview list items, and the workflow commands: refresh and apply, and
that sync is one-way and target-only accounts are preserved), and explicitly
state the script impact (no new npm scripts were added or list any new scripts
if they exist, e.g., npm run codex:sync), ensuring README and SECURITY docs are
updated to remain consistent with the CLI flags and workflows; place the note
under the appropriate version header and reference the refresh/apply commands
and backup file names (.bak, .wal) so migration guidance is complete.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 2775292d-4657-4979-a5f3-326d8fda4337
📒 Files selected for processing (6)
README.mddocs/features.mddocs/reference/commands.mddocs/reference/settings.mddocs/troubleshooting.mdtest/documentation.test.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Greptile Review
🧰 Additional context used
📓 Path-based instructions (2)
docs/**
⚙️ CodeRabbit configuration file
keep README, SECURITY, and docs consistent with actual CLI flags and workflows. whenever behavior changes, require updated upgrade notes and mention new npm scripts.
Files:
docs/reference/commands.mddocs/features.mddocs/reference/settings.mddocs/troubleshooting.md
test/**
⚙️ CodeRabbit configuration file
tests must stay deterministic and use vitest. demand regression cases that reproduce concurrency bugs, token refresh races, and windows filesystem behavior. reject changes that mock real secrets or skip assertions.
Files:
test/documentation.test.ts
🔇 Additional comments (5)
README.md (1)
247-247: good fix on backup-root troubleshooting guidance.this now correctly ties restore location to
CODEX_MULTI_AUTH_DIRwith windows/unix examples, which matches runtime path derivation (lib/storage.ts:924,lib/named-backup-export.ts:169).docs/features.md (1)
12-13: looks good and consistent with the shipped front-door flow.line 12, line 13, line 27, line 58, and line 59 read clearly and keep command/workflow mapping consistent.
Also applies to: 27-27, 58-59
docs/reference/commands.md (1)
23-23: nice cleanup on command-surface wording and workflow paths.line 23 and line 104-112 remove ambiguity and make dashboard-to-diagnostics navigation explicit.
Also applies to: 94-99, 104-112
docs/troubleshooting.md (1)
62-70: good expansion of restore and sync troubleshooting coverage.line 62-70 and line 83-93 are actionable and align with the documented interactive flows.
Also applies to: 83-93, 118-122
test/documentation.test.ts (1)
347-347: assertion update is correct.
test/documentation.test.ts:347now matches the renamed heading and keeps the docs contract test stable.
| The Settings menu now includes an `Experimental` section for staged features: | ||
|
|
||
| - preview-first sync into `oc-chatgpt-multi-auth` | ||
| - preview-first sync into the companion `oc-chatgpt-multi-auth` account pool |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# verify stale naming references in docs and tests
rg -n -C2 'oc-chatgpt-multi-auth|codex-multi-auth' README.md docs testRepository: ndycode/codex-multi-auth
Length of output: 50382
update README and docs to use canonical package naming in experimental sync references.
README.md:214 and docs/reference/storage-paths.md:120 both reference oc-chatgpt-multi-auth where canonical naming should be codex-multi-auth to align with the rest of the front-door docs. this matters because test/documentation.test.ts already validates canonical naming consistency. fix both references to match the canonical naming policy.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 214, Replace the incorrect experimental sync package name
string "oc-chatgpt-multi-auth" with the canonical package name
"codex-multi-auth" wherever it appears in the docs (the README reference and the
storage-paths reference tested by documentation.test.ts); ensure both
occurrences are updated to "codex-multi-auth" so naming is consistent with the
front-door docs and the tests.
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/troubleshooting.md (1)
62-93: 🧹 Nitpick | 🔵 Trivialnew troubleshooting sections look good, but test coverage is incomplete.
the "Backup Restore Problems" (lines 62-70) and "Codex CLI Sync Problems" (lines 83-93) sections are well-structured and include the correct navigation paths with "Advanced & Operator" intermediate step.
however,
test/documentation.test.ts:371-372only asserts headings exist but doesn't validate the table content or guidance text. the pr objectives explicitly flag this as a test coverage gap. consider adding assertions for key troubleshooting rows (e.g., restore prompt visibility, one-way sync behavior).as per coding guidelines,
test/**should demand regression cases that reproduce concurrency bugs, token refresh races, and windows filesystem behavior — while this is docs-only, the windows path examples at line 66 (%CODEX_MULTI_AUTH_DIR%\backups) should have corresponding test validation.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/troubleshooting.md` around lines 62 - 93, The tests in test/documentation.test.ts only assert headings exist; add concrete assertions that validate key troubleshooting table rows and examples: assert the Backup Restore Problems table includes the Windows path string "%CODEX_MULTI_AUTH_DIR%\\backups" and the restore prompt guidance, and assert the Codex CLI Sync Problems table contains the "Sync preview looks one-way" row and its guidance text; implement these as text/regex checks (e.g., getByText or expect(renderedText).toMatch) in the same test file and add additional assertions that cover the documented Windows path behavior and the noted regression categories (concurrency/token-refresh/window-fs) as TODO regression-case placeholders so test/** enforces those coverage requirements.
♻️ Duplicate comments (1)
README.md (1)
214-214:⚠️ Potential issue | 🟡 Minorfix
oc-chatgpt-multi-authstale references in user-facing copy and documentation.the issue extends beyond README.md:214. test/documentation.test.ts:134-148 only enforces canonical naming on 7 specific docs files, but missed user-facing code:
- README.md:214:
oc-chatgpt-multi-auth→codex-multi-auth- lib/ui/copy.ts:92: "Sync Accounts to
oc-chatgpt-multi-auth" → "Sync Accounts tocodex-multi-auth" (user sees this in the UI)- docs/reference/settings.md:101 and docs/reference/storage-paths.md:120 also reference the stale name
note: lib/oc-chatgpt-target-detection.ts:366, 411, 437 intentionally use
oc-chatgpt-multi-authin error messages and env var names for backward compat; leave those alone.📝 proposed fixes
- preview-first sync into the companion `oc-chatgpt-multi-auth` account pool + preview-first sync into the companion `codex-multi-auth` account pool- experimentalSync: "Sync Accounts to oc-chatgpt-multi-auth", + experimentalSync: "Sync Accounts to codex-multi-auth",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 214, Update all user-facing occurrences of the stale name "oc-chatgpt-multi-auth" to "codex-multi-auth": change the README.md instance, replace the UI copy string in lib/ui/copy.ts (the "Sync Accounts to `oc-chatgpt-multi-auth`" text), and update docs/reference/settings.md and docs/reference/storage-paths.md; do not modify lib/oc-chatgpt-target-detection.ts which intentionally preserves the old name. Also extend test/documentation.test.ts (which currently validates only seven docs) to include these additional files or otherwise assert the canonical naming for README.md, lib/ui/copy.ts, docs/reference/settings.md, and docs/reference/storage-paths.md so the change is enforced.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/troubleshooting.md`:
- Around line 62-93: The tests in test/documentation.test.ts only assert
headings exist; add concrete assertions that validate key troubleshooting table
rows and examples: assert the Backup Restore Problems table includes the Windows
path string "%CODEX_MULTI_AUTH_DIR%\\backups" and the restore prompt guidance,
and assert the Codex CLI Sync Problems table contains the "Sync preview looks
one-way" row and its guidance text; implement these as text/regex checks (e.g.,
getByText or expect(renderedText).toMatch) in the same test file and add
additional assertions that cover the documented Windows path behavior and the
noted regression categories (concurrency/token-refresh/window-fs) as TODO
regression-case placeholders so test/** enforces those coverage requirements.
---
Duplicate comments:
In `@README.md`:
- Line 214: Update all user-facing occurrences of the stale name
"oc-chatgpt-multi-auth" to "codex-multi-auth": change the README.md instance,
replace the UI copy string in lib/ui/copy.ts (the "Sync Accounts to
`oc-chatgpt-multi-auth`" text), and update docs/reference/settings.md and
docs/reference/storage-paths.md; do not modify
lib/oc-chatgpt-target-detection.ts which intentionally preserves the old name.
Also extend test/documentation.test.ts (which currently validates only seven
docs) to include these additional files or otherwise assert the canonical naming
for README.md, lib/ui/copy.ts, docs/reference/settings.md, and
docs/reference/storage-paths.md so the change is enforced.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 02ffb39a-a779-474b-bbba-e7e1f19f3b0c
📒 Files selected for processing (5)
README.mddocs/index.mddocs/reference/commands.mddocs/troubleshooting.mdtest/documentation.test.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Greptile Review
🧰 Additional context used
📓 Path-based instructions (2)
docs/**
⚙️ CodeRabbit configuration file
keep README, SECURITY, and docs consistent with actual CLI flags and workflows. whenever behavior changes, require updated upgrade notes and mention new npm scripts.
Files:
docs/troubleshooting.mddocs/index.mddocs/reference/commands.md
test/**
⚙️ CodeRabbit configuration file
tests must stay deterministic and use vitest. demand regression cases that reproduce concurrency bugs, token refresh races, and windows filesystem behavior. reject changes that mock real secrets or skip assertions.
Files:
test/documentation.test.ts
🔇 Additional comments (7)
docs/reference/commands.md (1)
104-111: lgtm on the interactive dashboard workflows section.navigation paths correctly include the "Advanced & Operator" intermediate step for sync preview at line 108. this matches the fix intent from the commit message and aligns with
docs/reference/settings.mdsection headers.docs/troubleshooting.md (1)
118-121: interactive diagnostics paths are correctly structured.both paths at lines 120-121 properly include the "Advanced & Operator" intermediate navigation step, consistent with the settings reference and other docs.
test/documentation.test.ts (2)
364-379: new test covers section headings but lacks content validation depth.the test at lines 364-379 correctly validates the presence of the four new doc sections and verifies the navigation path strings include "Advanced & Operator". this addresses the header consistency requirement.
however, the assertions only check
.toContain()for strings — they don't validate:
- table row counts or structure in troubleshooting sections
- actual cli path correctness beyond string matching
- cross-file consistency for the same paths documented in
docs/reference/commands.md:108anddocs/index.md:47this is acceptable for a docs-only pr, but consider adding a cross-file path consistency check to catch future drift.
347-347: header rename assertion looks correct.the updated assertion at line 347 matches the "Advanced & Operator" header terminology used consistently across
docs/reference/settings.md,docs/troubleshooting.md:85, anddocs/reference/commands.md:108.docs/index.md (1)
44-48: interactive workflows section looks good.the navigation paths are correctly structured:
- line 46: backup restore doesn't need intermediate step (direct menu item)
- line 47: sync preview correctly includes "Advanced & Operator" intermediate step
- line 48: settings split correctly shows both "Everyday Settings" and "Advanced & Operator" options
consistent with
docs/reference/commands.md:108-110anddocs/troubleshooting.md:85.README.md (2)
115-119: interactive dashboard paths are correctly documented.line 118 sync preview path correctly includes the "Advanced & Operator" intermediate step, consistent with
docs/reference/commands.md:108,docs/index.md:47, anddocs/troubleshooting.md:85.
182-192: config path documentation improvements look good.lines 182-185 clarify the config file lookup order, and line 192 now correctly describes
CODEX_MULTI_AUTH_CONFIG_PATHas overriding the default lookup rather than just being an "alternate source". this addresses the past review feedback about env var precedence.
Summary
#80fresh/05-settings-productizationWhat Changed
Validation
npm run lintnpm run typechecknpm testnpm test -- test/documentation.test.tsnpm run buildDocs and Governance Checklist
docs/getting-started.mdupdated (if onboarding flow changed)docs/features.mdupdated (if capability surface changed)docs/reference/*pages updated (if commands/settings/paths changed)docs/upgrade.mdupdated (if migration behavior changed)SECURITY.mdandCONTRIBUTING.mdreviewed for alignmentRisk and Rollback
01ee35bAdditional Notes
npm test.note: greptile review for oc-chatgpt-multi-auth. cite files like
lib/foo.ts:123. confirm regression tests + windows concurrency/token redaction coverage.Greptile Summary
docs-only PR that aligns README and the user-facing docs portal with the shipped settings split (
Everyday Settings/Advanced & Operator), startup restore prompt, backup restore manager, and codex CLI sync preview flow. all nine changed files are consistent with each other and with theUI_COPYconstants locked in the test suite.key changes:
docs/reference/settings.md: renames top-level section to## Advanced & Operator, replaces developer build commands under "Codex CLI Sync" with accurate user-facing workflow notesdocs/troubleshooting.md: addsBackup Restore ProblemsandCodex CLI Sync Problemstables with cross-platform paths; the previously flagged symptom/cause contradiction in the sync table is resolveddocs/getting-started.md: adds## Restore Or Start Freshand## Sync And Settingssections, but documents the backup location with a unix-only path (~/.codex/multi-auth/backups/<name>.json) — troubleshooting.md and README both include the windows equivalent, leaving a platform consistency gap for windows users reading the getting-started guidetest/documentation.test.ts: new alignment test validates section headings and nav paths but does not assert the windows backup path, leaving that gap unguarded by the test suiteConfidence Score: 4/5
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["codex auth login"] --> B{recoverable named\nbackups found\nand no accounts?} B -- yes, interactive TTY --> C["Startup restore prompt"] B -- no / non-interactive --> D["OAuth / Add Account flow"] C -- confirm --> E["Restore From Backup manager"] C -- skip --> D E --> F["Dedupe merge, apply"] F --> G["Account pool ready"] D --> G A --> H["Settings"] H --> I["Everyday Settings"] H --> J["Advanced & Operator"] I --> I1["List Appearance"] I --> I2["Details Line"] I --> I3["Results & Refresh"] I --> I4["Colors"] J --> J1["Codex CLI Sync\n(preview-first, one-way)"] J --> J2["Experimental\n(backup export, refresh guard)"] J --> J3["Advanced Backend Controls"]Prompt To Fix All With AI
Last reviewed commit: 52d2cfa