Skip to content

docs: fix 10 documentation-codebase drifts found by audit#3689

Merged
jqnatividad merged 4 commits intomasterfrom
doc-audit-2026-04-08
Apr 8, 2026
Merged

docs: fix 10 documentation-codebase drifts found by audit#3689
jqnatividad merged 4 commits intomasterfrom
doc-audit-2026-04-08

Conversation

@jqnatividad
Copy link
Copy Markdown
Collaborator

Summary

  • Fix qsvmcp missing to feature in README and FEATURES.md
  • Add blake3 to QSV_MAX_JOBS command list in ENVIRONMENT_VARIABLES.md
  • Fix QSV_MCP_USE_DUCKDB default from false to true
  • Add pragmastat to stats-cache dependencies in COMMAND_DEPENDENCIES.md
  • Remove incorrect index icon (📇) from foreach in README and TableOfContents.md
  • Fix stale mimalloc reference to jemalloc in whirlwind_tour.md
  • Fix qsvlite command count from 49 to 50 in mainlite.rs
  • Update test count from ~2,525 to ~3,000 in README
  • Add geocode to Homebrew features list in README

Test plan

  • Verify cargo test -F all_features passes (docs-only + one string literal change in mainlite.rs)
  • Spot-check README command table icons match src/cmd/*.rs feature gates
  • Confirm qsvlite --help shows "50 commands"

🤖 Generated with Claude Code

jqnatividad and others added 2 commits April 8, 2026 06:51
- Add missing `to` feature to qsvmcp description (README, FEATURES.md)
- Add `blake3` to QSV_MAX_JOBS command list (ENVIRONMENT_VARIABLES.md)
- Fix QSV_MCP_USE_DUCKDB default from `false` to `true` (ENVIRONMENT_VARIABLES.md)
- Add `pragmastat` to stats-cache dependencies (COMMAND_DEPENDENCIES.md)
- Remove incorrect index icon from `foreach` (README, TableOfContents.md)
- Fix stale mimalloc reference to jemalloc (whirlwind_tour.md)
- Fix qsvlite command count from 49 to 50 (mainlite.rs)
- Update test count from ~2,525 to ~3,000 (README)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Homebrew formula enables geocode in addition to apply, fetch, foreach,
lens, luau, and to. Verified against the current Homebrew formula.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jqnatividad jqnatividad requested a review from Copilot April 8, 2026 11:00
@codacy-production
Copy link
Copy Markdown

codacy-production bot commented Apr 8, 2026

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity 0

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown
Contributor

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

Updates documentation to match the current codebase (feature flags, env var defaults, command metadata), plus a small qsvlite help-text correction.

Changes:

  • Align qsvmcp feature descriptions (add missing to), update allocator reference to jemalloc, and refresh various README details (Homebrew features, test counts, command table icons).
  • Update env var documentation (add blake3 to QSV_MAX_JOBS list; set QSV_MCP_USE_DUCKDB default to true).
  • Adjust qsvlite “choose a command” banner text to reflect updated command count.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/mainlite.rs Updates qsvlite no-command banner text to new command count.
README.md Fixes command table icon drift, updates Homebrew feature list, qsvmcp description, and test-count approximations.
docs/whirlwind_tour.md Updates allocator reference from mimalloc to jemalloc.
docs/help/TableOfContents.md Removes incorrect index icon for foreach.
docs/FEATURES.md Updates qsvmcp feature list to include to.
docs/ENVIRONMENT_VARIABLES.md Adds blake3 to QSV_MAX_JOBS command list; updates MCP DuckDB default.
docs/COMMAND_DEPENDENCIES.md Documents pragmastat dependency on the stats JSONL cache.

jqnatividad and others added 2 commits April 8, 2026 07:29
The pipe characters in `MAD / |median|` were parsed as Markdown table
column delimiters, breaking the row. Changed to `MAD / abs(median)`.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jqnatividad jqnatividad merged commit b86825f into master Apr 8, 2026
1 check was pending
@jqnatividad jqnatividad deleted the doc-audit-2026-04-08 branch April 8, 2026 11:33
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