docs: documentation audit — fix toolchain drift, stale versions, and coverage gaps - #1302
Draft
cursor[bot] wants to merge 6 commits into
Draft
docs: documentation audit — fix toolchain drift, stale versions, and coverage gaps#1302cursor[bot] wants to merge 6 commits into
cursor[bot] wants to merge 6 commits into
Conversation
- Quick Reference: bun install/run/test → pnpm install/run, vitest - Project overview: clarify esbuild+fossilize build, not 'built with Bun' - Testing section: bun:test → vitest, BUN_TEST_WORKER_ID → VITEST_POOL_ID - Code examples: mock.module → vi.mock, import from 'vitest' not 'bun:test' - CI commands: bun run check:* → pnpm run check:* - Dependencies: bun add -d → pnpm add -D Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
- Node.js requirement: 22.15+ → 18+ (matches package.json engines) - Add WASM SQLite fallback note for Node.js 18–22.14 - Update pinned version example: 0.19.0 → 0.38.0 (current latest) Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
The proguard upload subcommand had no bash examples in the fragment, only proguard uuid was covered. Add examples for upload, --uuid, --no-upload, and multi-file upload. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
detect-agent.ts recognizes 11+ agents but agentic-usage.md only mentioned Claude Code and Cursor. Add a table showing all detected agents with their skill auto-install and telemetry detection status. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Update example version in env-registry.ts (SENTRY_VERSION description) and install script help text/examples to reflect current latest release. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Contributor
|
Contributor
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 5494 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 81.75% 81.75% —%
==========================================
Files 428 428 —
Lines 30106 30106 —
Branches 19593 19593 —
==========================================
+ Hits 24611 24612 +1
- Misses 5495 5494 -1
- Partials 2054 2056 +2Generated by Codecov Action |
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
1 participant
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.
Documentation Audit Report
Weekly automated audit of the Sentry CLI repository to find gaps between implementation and documentation. This PR contains fixes for the highest-impact findings.
Changes Made
AGENTS.md toolchain drift —
bun→pnpm/vitestthroughout Quick Reference and Testing sections. The project migrated to pnpm + vitest but AGENTS.md still referencedbun install,bun test,bun:test,mock.module(),BUN_TEST_WORKER_ID, etc. Also clarified project overview: "built with Bun" → esbuild + fossilize (Node SEA).getting-started.mdx Node.js version — Claimed npm/pnpm/yarn packages require "Node.js 22.15+" but
package.jsonenginessays>=18.0. Fixed to 18+ with WASM SQLite fallback note.Stale version pins — Updated example version
0.19.0→0.38.0(current latest) in getting-started.mdx, env-registry.ts (SENTRY_VERSIONdescription), and install script help text.proguard upload missing examples — Fragment only covered
proguard uuid. Added examples forproguard upload,--uuid,--no-upload, and multi-file upload.agentic-usage.md agent coverage — Only mentioned Claude Code and Cursor, but
detect-agent.tsrecognizes 11+ agents. Added supported agents table showing auto-install targets vs. telemetry-only detection.Full Gap Report
A. Undocumented or Missing Commands/Subcommands
No gaps found. All 107 primary commands and 17 hidden aliases in
src/app.tshave corresponding auto-generated doc pages. The doc generator (script/generate-command-docs.ts) produces pages from the Stricli route tree, andcheck:fragmentsvalidates fragment ↔ route consistency.B. Undocumented Flags
No significant gaps. All non-hidden flags are auto-documented in the generated Options tables. Hidden flags (
--log-level,--verbose,--org,--project) are documented once in the global options section (docs/src/fragments/commands/index.md).C. Missing Usage Examples
proguard uploadproguard.mdsnapshots diffsnapshots.mdsnapshots downloadsnapshots.mdD. Stale Descriptions
No gaps. Command
briefstrings in code match doc descriptions exactly because docs are auto-generated from the same source.E. Missing Route Mappings in Skill Generator
No gaps.
ROUTE_TO_REFERENCEwas removed and replaced by automatic 1:1 route→reference file generation viagroupRoutesByReference()inscript/generate-skill.ts.F. Installation / Distribution Gaps
package.jsonenginesgetting-started.mdxgetting-started.mdx,env-registry.ts,install--no-modify-path,--no-completions,--no-agent-skillsnot in getting-started.mdxinstallscriptgetting-started.mdx--helpG. Undocumented Environment Variables
No significant gaps.
configuration.mdis generated fromsrc/lib/env-registry.ts(28 entries). Internal-only env vars (SENTRY_ENVIRONMENT,SENTRY_TRACES_SAMPLE_RATE,SENTRY_SCAN_DISABLE_WORKERS,SENTRY_CLI_INTEGRATION_TEST_VERSION_OVERRIDE) are intentionally excluded — SDK passthrough or test-only.H. Auth / Self-Hosted Gaps
No significant gaps. Self-hosted docs correctly cover OAuth 26.1.0+ requirement,
SENTRY_CLIENT_ID,--urltrust anchor, TLS/proxy config, and token precedence. Minor:--scopevalidation details are undocumented (advanced use only).I. Plugin/Skills Gaps
detect-agent.tsagentic-usage.mdagent-skills.ts,detect-agent.tsagentic-usage.mdJ. README / DEVELOPMENT.md Drift
buncommands throughoutpackage.jsonusespnpm+vitestAGENTS.mdAGENTS.mdBUN_TEST_WORKER_IDVITEST_POOL_IDAGENTS.mdTop 5 Most Impactful Fixes