docs: comprehensive documentation gap audit report#972
Closed
cursor[bot] wants to merge 1 commit into
Closed
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>
Member
|
Superseded by #1050, which unifies the recurring BugBot documentation audits into a single PR. This PR only added a Closing in favor of #1050. |
BYK
added a commit
that referenced
this pull request
Jun 2, 2026
## Summary Consolidates the four recurring Cursor BugBot **"docs:"** audit PRs into a single set of verified fixes, and removes the *root cause* of the repeated audits. Supersedes and closes: - #972 — comprehensive documentation gap audit report - #946 — fix documentation gaps identified by automated audit - #1043 — fix stale architecture tree and phantom `--cause` flag - #909 — fix documentation gaps identified in comprehensive audit ## Root cause: AGENTS.md tree drift Every one of those PRs re-fixed the **hand-maintained architecture tree in `AGENTS.md`**. That tree drifts whenever a command or API module is added, so the weekly audit keeps re-filing it. The repo already generates an always-current project-structure tree into `docs/src/content/docs/contributing.md` via `script/generate-docs-sections.ts`. This PR **removes the duplicated tree from `AGENTS.md`** and replaces it with a concise pointer to the generated tree (plus `ls src/commands/` / `sentry --help`). This eliminates the recurring audit target permanently. ## Verified fixes harvested from the audits Each change was verified against current `main` source, not blindly cherry-picked: - **`issue.md`** — removed the phantom `sentry issue plan --cause 0` example. The `--cause` flag does not exist in `plan.ts`; `plan` automatically runs root-cause analysis (`ensureRootCauseAnalysis`) when needed. Requirements text updated accordingly. *(from #1043)* - **`src/lib/env-registry.ts`** — registered `SENTRY_INIT_TUI` (read at `src/lib/init/ui/factory.ts`) so it surfaces in the generated `configuration.md`. *(from #946)* - **`cli.md`** — documented `sentry cli defaults headers` and `sentry cli defaults ca-cert` (both implemented in `defaults.ts`). *(from #946)* - **`self-hosted.md`** — documented `auth login --url` as the recommended, trust-anchoring login method, and added a **TLS / Corporate Proxies** section (`NODE_EXTRA_CA_CERTS` + `cli defaults ca-cert`/`headers`). *(from #909)* - **`getting-started.mdx` / `README.md`** — noted the **Node.js 22.15+** requirement for npm/pnpm/yarn packages (matches `package.json` engines); added `yarn` install + `pnpm dlx`/`yarn dlx`/`bunx` run options to the README. *(from #909/#946)* Regenerated skill references (`references/issue.md`, `references/cli.md`) via `pnpm run generate:docs`. ## Discarded - The throwaway `DOCUMENTATION_GAPS.md` / `docs/DOCUMENTATION_GAPS.md` / `DOCUMENTATION_GAP_REPORT.md` audit artifacts are **not** committed, and are now gitignored so future bot audits don't accidentally commit them. - Skipped items already landed on `main` since the PRs opened (dashboard `revisions`/`restore` examples, `configuration.md` cross-refs) and the unverified Cursor `~/.agents` claim that #972 itself flagged as inaccurate. ## Verification - `pnpm run typecheck` ✅ - `pnpm run lint` ✅ (only pre-existing unrelated warning in `formatters/local.ts`) - `pnpm run check:fragments` ✅ (all 22 fragments valid) - `pnpm exec vitest run test/lib test/commands test/types` ✅ (5529 passed, 9 skipped) - Confirmed `SENTRY_INIT_TUI` appears in generated `configuration.md`.
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
2 participants
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.