Skip to content

docs: weekly documentation audit — add sentry docs/status coverage, install flags, plugin syntax - #1514

Draft
cursor[bot] wants to merge 2 commits into
mainfrom
cursor/sentry-cli-documentation-audit-53b8
Draft

docs: weekly documentation audit — add sentry docs/status coverage, install flags, plugin syntax#1514
cursor[bot] wants to merge 2 commits into
mainfrom
cursor/sentry-cli-documentation-audit-53b8

Conversation

@cursor

@cursor cursor Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Documentation Audit Report — 2026-08-31

Weekly audit comparing the Sentry CLI implementation (v0.45.0-dev.0) against its documentation. This covers changes since the last merged audit (#1461, 2026-08-24).


Findings Summary

Section Status
A. Undocumented commands ✅ No gaps — check:fragments CI enforces coverage
B. Undocumented flags ✅ No gaps — auto-generated from CLI metadata
C. Missing usage examples ✅ All 37 fragments have bash examples
D. Stale descriptions ✅ No drift — pulled from code at generation time
E. Missing route mappings ✅ No gaps — ROUTE_TO_REFERENCE replaced with auto 1:1 mapping
F. Installation gaps ⚠️ Install script flags undocumented in getting-started.mdx
G. Undocumented env vars ✅ No gaps — check:env-coverage CI enforces completeness
H. Auth/self-hosted gaps ⚠️ auth refresh --read-only/--scope examples missing
I. Plugin/skills gaps ⚠️ sentry docs missing from agentic pages; stale plugin syntax
J. README/DEVELOPMENT.md drift ✅ No drift — auto-generated marker sections

Changes Made

1. Add sentry docs and sentry status to agentic guidance (I1, I2)

The sentry docs command suite (#1457) and sentry status command (#1494) are recent additions that are highly relevant for AI agent workflows but were not mentioned in agentic-usage.md or agent-guidance.md. Added:

  • New capability in agentic-usage.md: "Query documentation"
  • New examples: sentry docs "How do I set up source maps?" and sentry status
  • New workflow patterns in agent-guidance.md for documentation querying and status checking
  • New key principle: "Use sentry docs for setup questions"
  • New common mistake entry about fetching docs externally

2. Document install script flags in getting-started.mdx (F1)

The install script accepts --no-modify-path, --no-completions, and --no-agent-skills flags, plus the SENTRY_INSTALL_DIR env var. These were documented in the CLI fragment (cli.md) but not on the Getting Started page where users encounter the install script.

3. Update plugins/README.md installation syntax (I3)

Replaced deprecated Claude Code claude plugin marketplace add / claude plugin install commands with current dotagents-based installation and automatic skill installation documentation.

4. Add auth refresh scoped examples (H1)

Added --read-only and --scope examples to the auth refresh section in auth.md fragment.


Top 5 Most Impactful Fixes (prioritized)

  1. sentry docs in agentic pages — Primary agent tool for documentation queries, invisible without this
  2. Install script flags in getting-started — CI/Docker users need --no-agent-skills etc.
  3. Plugin syntax update — Deprecated commands that no longer work
  4. sentry docs workflow pattern — Natural addition to detailed agent guidance
  5. auth refresh scoped examples — Minor but useful for agents and CI
Open in Web View Automation 

…nstall flags, plugin syntax

- Add sentry docs command to agentic-usage.md capabilities and examples
- Add sentry docs and sentry status workflow patterns to agent-guidance.md
- Add sentry docs to agent-guidance key principles and common mistakes
- Document install script --no-modify-path, --no-completions, --no-agent-skills
  flags and SENTRY_INSTALL_DIR in getting-started.mdx
- Update plugins/README.md to replace deprecated Claude Code marketplace
  syntax with dotagents and automatic installation instructions
- Add auth refresh --read-only and --scope examples to auth.md fragment

Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com>
@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cli Ready Ready Preview Aug 31, 2026 12:23pm

Request Review

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