docs: rewrite product docs for current 2.6.1 architecture - #632
Conversation
Align README, user guides, reference pages, and maintainer maps with the shipped manager/wrapper/mcodex surfaces, default-on runtime rotation, local governance, bridge tokens, and first-run setup.
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (29)
Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to data retention organization setting 📝 WalkthroughMinor-risk, documentation-focused rewrite aligning the repository with the shipped 2.6.1 manager-first architecture; no production behavior or data-storage logic is changed. Reviewers should focus on the default-on runtime rotation proxy, optional wrapper/ Highlights
Walkthroughthe pull request updates architecture, configuration, storage, onboarding, command references, cli help, release-history documentation, and matching integrity tests for the expanded codex-multi-auth surface. Changesdocumentation and cli alignment
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
test/cli-output-contracts.test.tsOops! Something went wrong! :( ESLint: 10.0.0 Error: The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it. test/codex-manager-cli.test.tsOops! Something went wrong! :( ESLint: 10.0.0 Error: The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it. test/documentation.test.tsOops! Something went wrong! :( ESLint: 10.0.0 Error: The 'jiti' library is required for loading TypeScript configuration files. Make sure to install it. 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 |
Correct budget flags, config source precedence, list/status identity, login --org, report/forecast flags, app-launcher platforms, storage paths, and anti-abuse field inventory after a code-vs-docs deep audit.
Expand CLI help and feature checklist, document bridge host start API, complete release portal links, full advanced env matrix, ownership map modules, and harden documentation tests so residual P2 gaps stay closed.
Minor release adding quota reset timestamps to `codex-multi-auth check` (#633), plus the product-docs rewrite that landed after 2.6.1 was cut (#632). - `check` now prints when each quota window resets alongside the percentage left: `live session OK (5h 100%, resets 18:10 | 7d 93%, resets 13:50 on Jul 29)`. Local timezone, 24-hour clock; the date is appended once the reset is past midnight - reset display is opt-in at the formatter level and scoped to `check`, so the dashboard rows, account menu, and `forecast` are byte-identical to 2.6.1 - quota percentages keep their red/yellow/green tone when a reset time is shown; the anchored `styleQuotaSummary` pattern would otherwise have dropped every segment to muted - a missing, zero, negative, non-finite, or unparseable reset timestamp drops only the reset clause, never the percentage or the account check Also restores the v2.6.1 row in the docs portal release table: the 2.6.1 release replaced the v2.6.0 row instead of adding one, which the docs integrity test now catches. Routing, rotation, storage, quota math, and the token flow are unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]> Claude-Session: https://claude.ai/code/session_01Xetj6c94ZqD7a5n7G9M5Ro
Summary
mcodex, runtime rotation default-on).first-run-setup.json).docs/releases/*and audit snapshots as archives; updates architecture maps inAGENTS.md/lib/AGENTS.md.Key accuracy fixes
mcodex(not three)pause/draindocumented as runtime-enforced viaevaluateRuntimePolicygpt-5.6-sol/gpt-5.5Test plan
npx vitest run --maxWorkers=1 test/documentation.test.ts(26/26 passed)docs/README.mdcodex-multi-auth/mcodex/ rotation sections againstlib/codex-manager/help.tsandpackage.jsonbinsnote: 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 the full user, reference, and maintainer docs to match the shipped 2.6.1 architecture: four published bins, default-on runtime rotation, local governance (usage/budget/policies), bridge tokens, account pause/drain runtime enforcement, and first-run setup. source changes are narrow — expanding
IMPLEMENTED_FEATURESto 54 entries, updatinghelp.tsflag signatures, and updating the test suite to match.docs/reference/commands.mdanddocs/development/ARCHITECTURE.mdare the heaviest changes; both are accurate againstlib/AGENTS.mdandlib/codex-manager/help.ts.test/documentation.test.tsadds two new integrity tests and updates stable release pins to v2.6.0/v2.5.0.test/cli-output-contracts.test.tsdropsbudget check|list [--json]andusage rotatefrom the contract anchor list.docs/getting-started.mduseswhere codex-multi-auth(Windows-only) in the first-run troubleshooting block; macOS/Linux users needwhich.Confidence Score: 4/5
safe to merge after fixing the
where/whichcross-platform issue in getting-started.mdthe docs are accurate against the shipped architecture and the source changes are narrow and well-tested. the one actionable problem is
where codex-multi-authin the first-run troubleshooting block — it is a Windows-only built-in and will silently fail for every macOS and Linux user who hits that path, giving them a confusing second error on top of an already-broken install.docs/getting-started.md line 229 (
where→ addwhichfor macOS/Linux); test/cli-output-contracts.test.ts (budget check|list and usage rotate missing from contract anchors)Important Files Changed
where codex-multi-authon line 229 is Windows-only — breaks macOS/Linux usersComments Outside Diff (3)
docs/getting-started.md, line 229-231 (link)whereis windows-onlywhere codex-multi-authis a Windows shell built-in; it will return "not recognized" on macOS and Linux. the companion upgrade guide already uses the correct dual form:where codex-multi-auth(Windows) orwhich codex-multi-auth(macOS/Linux). users hitting install problems on unix will get a confusing second failure when following this step.bash
where codex-multi-auth # Windows
which codex-multi-auth # macOS / Linux
Prompt To Fix With AI
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!
docs/development/TESTING.md, line 14-16 (link)the PR test plan reports
26/26passes intest/documentation.test.ts, which exercises structural integrity (links, field lists). however, the newly documented command paths —workspace,bridge token create/rotate/revoke,mcodex --tmux --live-accounts, and the governance commands (account pause/drain,budget limit) — don't appear to have new runtime behavior tests added. given the windows filesystem token-safety notes in the architecture docs (retry onEBUSY/EPERM), any new file-backed governance write paths especially warrant dedicated vitest coverage.Prompt To Fix With AI
docs/getting-started.md, line 226-230 (link)whereis a Windows-only built-in — it prints "not recognized" on macOS and Linux. the upgrade guide already uses the dual form; apply it here too.bash
where codex-multi-auth # Windows
which codex-multi-auth # macOS / Linux
Prompt To Fix With AI
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!
Prompt To Fix All With AI
Reviews (2): Last reviewed commit: "docs: close remaining architecture cover..." | Re-trigger Greptile