docs: fix documentation gaps identified by automated audit#946
Draft
cursor[bot] wants to merge 7 commits into
Draft
docs: fix documentation gaps identified by automated audit#946cursor[bot] wants to merge 7 commits into
cursor[bot] wants to merge 7 commits into
Conversation
…port - Add missing replay/, explore.ts to commands tree - Add dashboard/revisions, dashboard/restore, issue/archive subcommands - Add missing API modules: dashboards, discover, releases, replays, repositories, sourcemaps, teams, users - Add comprehensive documentation gap report at docs/DOCUMENTATION_GAPS.md Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
This env var controls the TUI for 'sentry init' and was missing from the registry, which means it didn't appear in the generated configuration.md page. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Add yarn to the package managers section and add pnpm dlx, yarn dlx, and bunx to the run-without-installing section, matching the options already documented in getting-started.mdx. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Add --no-modify-path, --no-completions, --no-agent-skills flags, plus SENTRY_VERSION, SENTRY_INSTALL_DIR, and SENTRY_INIT env vars to the install script section. These are useful for CI/CD and Docker setups. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
- Add bash examples for 'dashboard revisions' and 'dashboard restore' commands to the dashboard fragment - Add 'headers' and 'ca-cert' sub-key examples to the configuration fragment's defaults section Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Add note that automatic skill installation requires ~/.claude or ~/.agents to already exist — the installer does not create these directories. Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
Contributor
|
Contributor
Codecov Results 📊✅ 6856 passed | Total: 6856 | 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 14140 uncovered lines. Coverage diff@@ Coverage Diff @@
## main #PR +/-##
==========================================
- Coverage 76.97% 76.86% -0.11%
==========================================
Files 319 319 —
Lines 60994 61094 +100
Branches 0 0 —
==========================================
+ Hits 46947 46954 +7
- Misses 14047 14140 +93
- Partials 0 0 —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.
Summary
Automated documentation audit comparing the full CLI implementation against all documentation surfaces. This PR fixes the top-priority gaps and includes a comprehensive gap report.
Documentation Gap Report
Full report at
docs/DOCUMENTATION_GAPS.md. Key findings:A. Stale Architecture Tree in AGENTS.md
The manually maintained architecture tree was missing:
replay/command group (list, view)explore.tsstandalone commanddashboard/revisionsanddashboard/restoresubcommandsissue/archivesubcommanddashboards,discover,releases,replays,repositories,sourcemaps,teams,users)B. Undocumented Environment Variable
SENTRY_INIT_TUI(disables the TUI forsentry init— useful for CI/Docker) was referenced in code but missing from the env var registry, so it didn't appear in the generatedconfiguration.md.C. README.md Installation Gaps
yarnas a package manager install optionpnpm dlx,yarn dlx, andbunxas run-without-installing optionsD. Installer Flags Not Documented
The install script accepts
--no-modify-path,--no-completions, and--no-agent-skillsflags, plusSENTRY_INSTALL_DIRandSENTRY_INITenv vars — none were documented ingetting-started.mdx.E. Missing Command Examples in Fragments
dashboard revisionsanddashboard restorehad no examplessentry cli defaultswas missingheadersandca-certsub-key examplesF. Agent Skills Prerequisite Not Documented
Auto-install requires
~/.claudeor~/.agentsto already exist — the installer doesn't create these directories. This wasn't mentioned.Changes
AGENTS.md— Updated architecture tree: addedreplay/,explore.ts,dashboard/revisions|restore,issue/archive, and 8 missing API modulessrc/lib/env-registry.ts— AddedSENTRY_INIT_TUIenv var entryREADME.md— Addedyarninstall method +pnpm dlx/yarn dlx/bunxrun-without-installing optionsdocs/src/content/docs/getting-started.mdx— Documented installer flags (--no-modify-path,--no-completions,--no-agent-skills) and env vars (SENTRY_VERSION,SENTRY_INSTALL_DIR,SENTRY_INIT)docs/src/fragments/commands/dashboard.md— Added examples fordashboard revisionsanddashboard restoredocs/src/fragments/configuration.md— Addedheadersandca-certsub-key examples to defaults sectiondocs/src/content/docs/agentic-usage.md— Added note about pre-existing directory requirement for auto skill installdocs/DOCUMENTATION_GAPS.md— Full structured gap report covering all 10 audit categoriesWhat's Working Well
generate-docs-sections.ts