docs: weekly documentation audit — add sentry docs/status coverage, install flags, plugin syntax - #1514
Draft
cursor[bot] wants to merge 2 commits into
Draft
docs: weekly documentation audit — add sentry docs/status coverage, install flags, plugin syntax#1514cursor[bot] wants to merge 2 commits into
cursor[bot] wants to merge 2 commits into
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
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
check:fragmentsCI enforces coverageROUTE_TO_REFERENCEreplaced with auto 1:1 mappingcheck:env-coverageCI enforces completenessauth refresh --read-only/--scopeexamples missingsentry docsmissing from agentic pages; stale plugin syntaxChanges Made
1. Add
sentry docsandsentry statusto agentic guidance (I1, I2)The
sentry docscommand suite (#1457) andsentry statuscommand (#1494) are recent additions that are highly relevant for AI agent workflows but were not mentioned inagentic-usage.mdoragent-guidance.md. Added:sentry docs "How do I set up source maps?"andsentry statussentry docsfor setup questions"2. Document install script flags in getting-started.mdx (F1)
The install script accepts
--no-modify-path,--no-completions, and--no-agent-skillsflags, plus theSENTRY_INSTALL_DIRenv 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 installcommands with current dotagents-based installation and automatic skill installation documentation.4. Add
auth refreshscoped examples (H1)Added
--read-onlyand--scopeexamples to theauth refreshsection inauth.mdfragment.Top 5 Most Impactful Fixes (prioritized)
sentry docsin agentic pages — Primary agent tool for documentation queries, invisible without this--no-agent-skillsetc.sentry docsworkflow pattern — Natural addition to detailed agent guidanceauth refreshscoped examples — Minor but useful for agents and CI