docs: documentation audit — fix AGENTS.md drift, expand installation & agentic docs#1078
Draft
cursor[bot] wants to merge 2 commits into
Draft
docs: documentation audit — fix AGENTS.md drift, expand installation & agentic docs#1078cursor[bot] wants to merge 2 commits into
cursor[bot] wants to merge 2 commits into
Conversation
…test AGENTS.md contained extensive Bun-specific guidance that no longer matched the codebase after the migration to pnpm + Node.js + vitest: - Replace 'Built with Bun' with 'Built with Node.js' - Replace all bun commands (bun install, bun test, etc.) with pnpm equivalents - Remove Bun API reference table (Bun.file, Bun.write, Bun.spawn, etc.) - Replace with Node.js API guidance (node:fs, node:child_process) - Fix test framework references from bun:test to vitest - Fix mock API from mock.module() to vi.mock() - Fix test runner config references from Bun flags to vitest.config.ts - Fix BUN_TEST_WORKER_ID to VITEST_POOL_ID - Remove stale .cursor/rules/bun-cli.mdc reference - Replace bun run check:* with pnpm run check:* - Replace bun run generate:* with pnpm run generate:* Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
…E docs - Document --no-modify-path, --no-completions, --no-agent-skills installer flags - Document SENTRY_INSTALL_DIR and SENTRY_INIT env vars for the installer - Add CI/Docker example for non-interactive installs - Add Claude Code marketplace install instructions to agentic-usage.md - Add Cursor plugin installation instructions to agentic-usage.md - Expand Requirements section with specific IDE links - Add documentation audit report as docs/DOCUMENTATION_AUDIT.md Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Contributor
|
Contributor
Codecov Results 📊✅ Patch coverage is 100.00%. Project has 4835 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 81.53% 81.53% —%
==========================================
Files 374 374 —
Lines 26173 26173 —
Branches 17080 17080 —
==========================================
+ Hits 21339 21338 -1
- Misses 4834 4835 +1
- Partials 1768 1768 —Generated 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
Full audit of the Sentry CLI repository documentation against the actual implementation. The audit covers commands, flags, installation methods, auth flows, configuration, environment variables, the plugin/skills system, and root docs (README, DEVELOPMENT.md, AGENTS.md).
Changes Made
1. Fix AGENTS.md Bun→pnpm/Node/vitest migration (Critical)
AGENTS.md contained extensive Bun-specific guidance that no longer matches the codebase:
buncommands (bun install,bun test, etc.) →pnpmequivalentsBun.file,Bun.write,Bun.spawn, etc.)node:fs,node:child_process)bun:test→vitestmock.module()→vi.mock()vitest.config.tsBUN_TEST_WORKER_ID→VITEST_POOL_ID.cursor/rules/bun-cli.mdcreferencebun run check:*→pnpm run check:*2. Add installer flags to getting-started.mdx
--no-modify-path,--no-completions,--no-agent-skillsinstaller flagsSENTRY_INSTALL_DIRandSENTRY_INITenv vars3. Expand agentic-usage.md with IDE-specific install instructions
claude plugin marketplace add getsentry/cli).cursor/skills/symlink4. Add documentation audit report
The full audit report is in
docs/DOCUMENTATION_AUDIT.mdwith findings across 10 categories (A-J). Key findings not yet fixed (for future work):SENTRY_SPOTLIGHT,SENTRY_TRACES_SAMPLE_RATE,SENTRY_MONITOR_SLUGused in code but not in env-registry.ts (intentionally excluded as injected vars)npx skills addmay reference an external tool that no longer existsAudit Summary