docs: Fix documentation gaps identified in comprehensive audit#909
Closed
cursor[bot] wants to merge 1 commit into
Closed
docs: Fix documentation gaps identified in comprehensive audit#909cursor[bot] wants to merge 1 commit into
cursor[bot] wants to merge 1 commit into
Conversation
- self-hosted.md: Add --url flag as recommended auth method, add TLS/CA section - getting-started.mdx: Note Node.js 22.12+ requirement for npm installs - README.md: Add yarn to installation methods, note Node.js requirement - AGENTS.md: Add replay/ and explore.ts to architecture tree, add archive to issue commands - agentic-usage.md: Document Claude plugin marketplace and Cursor skill paths - Add comprehensive DOCUMENTATION_GAP_REPORT.md with full audit findings Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Contributor
|
Contributor
Codecov Results 📊✅ 6660 passed | Total: 6660 | Pass Rate: 100% | Execution Time: 0ms 📊 Comparison with Base Branch
✨ No test changes detected All tests are passing successfully. ✅ Patch coverage is 100.00%. Project has 13508 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
+ Coverage 76.62% 76.62% —%
==========================================
Files 303 303 —
Lines 57782 57784 +2
Branches 0 0 —
==========================================
+ Hits 44276 44276 —
- Misses 13506 13508 +2
- Partials 0 0 —Generated by Codecov Action |
Member
|
Superseded by #1050, which unifies the recurring BugBot documentation audits into a single PR. Harvested from this PR into #1050: the self-hosted 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 addresses documentation gaps found through a comprehensive audit comparing the CLI implementation against its documentation. The audit read all root docs, command fragments, route maps, installation code, auth/config code, and the plugin/skills system.
Changes
Fixes Applied
self-hosted.md: Added--urlflag as the recommended authentication method (more secure than env vars — registers a trust anchor). Added TLS/CA certificate section withsentry cli defaults ca-certandNODE_EXTRA_CA_CERTS.getting-started.mdx: Added Node.js 22.12+ requirement note next to package manager installation commands.README.md: Addedyarnto installation methods (was already in getting-started.mdx). Added Node.js version requirement note.AGENTS.md: Updated architecture tree to includereplay/directory,explore.tscommand, andarchivein issue subcommands — all were missing from the tree.agentic-usage.md: Documented Claude plugin marketplace installation path and Cursor-specific skill location.Gap Report
A full
docs/DOCUMENTATION_GAP_REPORT.mdis included with structured findings across 10 categories:--urlon auth login,--offlineon upgrade, replay sort/period)The top 5 most impactful fixes are implemented in this PR. The report also lists 5 additional lower-priority gaps for future work.