Skip to content

docs: sync website + README + CLAUDE.md with current code#21

Merged
jamesbrink merged 1 commit into
mainfrom
docs/sync-truthfulness
May 16, 2026
Merged

docs: sync website + README + CLAUDE.md with current code#21
jamesbrink merged 1 commit into
mainfrom
docs/sync-truthfulness

Conversation

@jamesbrink
Copy link
Copy Markdown
Member

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).

  • Bumps documented schema_version from 2 → 3 to match src/index.rs:17.
  • Adds src/stats.rs (the percentile_sorted helper) to the modules tables in both CLAUDE.md and website/guide/architecture.md.
  • Removes completions from the src/commands/*.rs listing — it's actually a helper in main.rs, not a module file under commands/.
  • Adds the missing hyperlink for codex in the README subcommands table.
  • Tightens website/guide/index.md's "Every read command" bullets so they correctly call out that models, turns, prs, and files are index-only (no --no-index), and that claudex codex is a separate reader that scans ~/.codex/ and never touches the Claude Code index.
  • Adds an invariant note in CLAUDE.md flagging codex as 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 in website/reference/pricing.md, the schema page in website/reference/schema.md, and every per-command page were spot-checked against src/main.rs / src/types.rs / src/index.rs and found accurate; no changes needed there.

Test plan

  • bun fmt:check passes
  • bun run build (vitepress) builds clean
  • ci-local passes (fmt-check → check → clippy → test → build), 203 tests green
  • Confirm PR preview / Pages deploy renders the architecture and guide tables correctly after merge

- 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
Copy link
Copy Markdown

codecov Bot commented May 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.51%. Comparing base (a4a4d0c) to head (26b44d9).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.rs to 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 jamesbrink merged commit ea7e391 into main May 16, 2026
12 of 13 checks passed
@jamesbrink jamesbrink deleted the docs/sync-truthfulness branch May 16, 2026 02:50
@jamesbrink jamesbrink mentioned this pull request May 16, 2026
5 tasks
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).
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.

2 participants