Skip to content

docs: comprehensive documentation gap audit report#972

Draft
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/sentry-cli-documentation-gaps-04a7
Draft

docs: comprehensive documentation gap audit report#972
cursor[bot] wants to merge 1 commit into
mainfrom
cursor/sentry-cli-documentation-gaps-04a7

Conversation

@cursor
Copy link
Copy Markdown
Contributor

@cursor cursor Bot commented May 18, 2026

Summary

This PR adds a comprehensive documentation gap report (DOCUMENTATION_GAPS.md) produced by auditing the full repository — cross-referencing every command implementation in src/commands/ against the documentation in README.md, DEVELOPMENT.md, docs/src/content/docs/, and docs/src/fragments/commands/.

Methodology

  1. Read all root documentation files (README, DEVELOPMENT.md, AGENTS.md, doc site pages)
  2. Read all 21 command documentation fragments under docs/src/fragments/commands/
  3. Read every command implementation file (src/commands/*/) extracting flags, descriptions, and positional args
  4. Read installation/distribution code (install script, .craft.yml, package.json, setup/upgrade)
  5. Read auth/configuration code and plugin/skills system
  6. Cross-referenced findings into a structured gap report

Key Findings

The report is organized into 10 sections (A–J):

  • A. Undocumented commandsdashboard revisions and dashboard restore have no documentation
  • B. Undocumented flags — 30+ non-hidden flags across commands lack documentation (notably --spans, --timeout, --offline, --method, sourcemap flags)
  • C. Missing usage examples — Several commands lack standalone examples
  • D. Stale descriptions — Minor inconsistencies only (generated system keeps things in sync)
  • E. Skill generator routes — No gaps (automatic 1:1 mapping)
  • F. Installation gaps — Node.js ≥22.12 requirement not documented for npm users; install script flags undocumented
  • G. Undocumented env varsSENTRY_RELEASE, SENTRY_NO_CACHE, SENTRY_PLAIN_OUTPUT, and others missing from config page
  • H. Auth/self-hosted gaps--url flag and trust anchor behavior undocumented
  • I. Plugin/skills gaps — Cursor support description inconsistent between docs
  • J. README drift — Minor (yarn missing from README, redundant dev commands)

Top 5 Priorities

  1. Add Node.js ≥22.12 requirement to getting-started docs
  2. Document --url flag for self-hosted login
  3. Add dashboard revisions/restore documentation
  4. Document sourcemap upload flags (--dist, --ignore, etc.)
  5. Document sentry cli defaults headers/ca-cert in self-hosted guide

Next Steps

This report is intended as a reference for prioritizing documentation work. Each section includes source file references so individual gaps can be addressed incrementally.

Open in Web View Automation 

Audit the full repository to cross-reference implementation code against
documentation (README.md, DEVELOPMENT.md, docs site, fragments). The report
identifies:

- Undocumented commands (dashboard revisions/restore)
- Undocumented flags across 15+ commands
- Missing usage examples
- Installation/distribution documentation gaps
- Undocumented environment variables
- Auth/self-hosted documentation gaps
- Plugin/skills system inconsistencies
- README/DEVELOPMENT.md drift

Includes a prioritized list of the top 5 most impactful fixes.

Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
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.

1 participant