docs: comprehensive documentation gap audit report#972
Draft
cursor[bot] wants to merge 1 commit into
Draft
Conversation
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>
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
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.
Summary
This PR adds a comprehensive documentation gap report (
DOCUMENTATION_GAPS.md) produced by auditing the full repository — cross-referencing every command implementation insrc/commands/against the documentation inREADME.md,DEVELOPMENT.md,docs/src/content/docs/, anddocs/src/fragments/commands/.Methodology
docs/src/fragments/commands/src/commands/*/) extracting flags, descriptions, and positional argsKey Findings
The report is organized into 10 sections (A–J):
dashboard revisionsanddashboard restorehave no documentation--spans,--timeout,--offline,--method, sourcemap flags)SENTRY_RELEASE,SENTRY_NO_CACHE,SENTRY_PLAIN_OUTPUT, and others missing from config page--urlflag and trust anchor behavior undocumentedTop 5 Priorities
--urlflag for self-hosted logindashboard revisions/restoredocumentation--dist,--ignore, etc.)sentry cli defaults headers/ca-certin self-hosted guideNext 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.