docs: sync website + README + CLAUDE.md with current code#21
Merged
Conversation
- Bump documented schema_version from 2 → 3 (matches src/index.rs). - Add src/stats.rs to the modules table in CLAUDE.md and architecture.md. - Drop completions from the src/commands/*.rs list — it's a helper in main.rs, not a module file. - Add codex to the README subcommands table as a hyperlink. - Tighten guide/index.md "Every read command" claims so they correctly call out that models/turns/prs/files are index-only and codex reads ~/.codex directly without touching the Claude Code index. - Note in CLAUDE.md that codex is the single exception to the index pipeline and list the actual state file (state_5.sqlite).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #21 +/- ##
==========================================
- Coverage 79.54% 79.51% -0.04%
==========================================
Files 23 23
Lines 6166 6166
==========================================
- Hits 4905 4903 -2
- Misses 1261 1263 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR synchronizes documentation with the current claudex codebase, especially around schema versioning, the new stats helper module, and the Codex command’s separate data path.
Changes:
- Updates documented index schema version from 2 to 3.
- Adds
src/stats.rsto architecture/module documentation. - Clarifies command listings and flag behavior for
codex,--no-index, and completions.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
website/guide/index.md |
Clarifies common read-command flags and index-related caveats. |
website/guide/architecture.md |
Updates module table with src/stats.rs and corrected command module list. |
README.md |
Adds missing Codex command documentation link. |
CLAUDE.md |
Updates schema version, module list, and Codex index-pipeline invariant. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jamesbrink
added a commit
that referenced
this pull request
May 16, 2026
Headline: new `claudex codex` report, `summary --plan flat-monthly:USD` flag, and a packaged Claude Code skill at `.claude/skills/claudex/`. - Bump version 0.3.0 → 0.4.0 in Cargo.toml, Cargo.lock, vitepress nav, README, and installation.md. - Promote CHANGELOG [Unreleased] → [0.4.0] — 2026-05-15 with entries for #18 (skill), #19 (codex), #20 (--plan flat-monthly), and #21 (docs sync).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A targeted audit pass to bring the docs back in sync with the code after recent changes (codex command, schema bump, src/stats.rs).
schema_versionfrom 2 → 3 to matchsrc/index.rs:17.src/stats.rs(thepercentile_sortedhelper) to the modules tables in bothCLAUDE.mdandwebsite/guide/architecture.md.completionsfrom thesrc/commands/*.rslisting — it's actually a helper inmain.rs, not a module file undercommands/.codexin the README subcommands table.website/guide/index.md's "Every read command" bullets so they correctly call out thatmodels,turns,prs, andfilesare index-only (no--no-index), and thatclaudex codexis a separate reader that scans~/.codex/and never touches the Claude Code index.CLAUDE.mdflaggingcodexas the one subcommand that bypasses the index pipeline, and lists the actual state file (state_5.sqlite) it opens.The flag matrix in
website/commands/index.md, the pricing table inwebsite/reference/pricing.md, the schema page inwebsite/reference/schema.md, and every per-command page were spot-checked againstsrc/main.rs/src/types.rs/src/index.rsand found accurate; no changes needed there.Test plan
bun fmt:checkpassesbun run build(vitepress) builds cleanci-localpasses (fmt-check → check → clippy → test → build), 203 tests green