Repository navigation
docs(cli): Fix broken doc links and stale SDK examples - #1542
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
BYK
approved these changes
Oct 19, 2026
This branch was previously deployed
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.
Summary
Fixes CLI docs links that 404 on cli.sentry.dev and corrects library and env var docs that no longer match the CLI. Every change was checked against
packages/cli.What changed
/features/), so./configuration/resolved to/features/configuration/and returned 404. Links infeatures.md,library-usage.md,self-hosted.md, theconfigurationandauthfragments, and the env var descriptions inenv-registry.tsnow use the right relative paths. The/installation/link inlibrary-usage.mdnow points to the installation page (getting-started), and thesentry cli defaultsanchor now matches the generated heading. Checked against the built site: the newdisthas no broken internal links or anchors (it had 14 before).irm https://cli.sentry.dev/install.ps1 | iex). Fixed the library examples:sdk.issue.viewtakes the issue ID as a positional argument, andsdk.dashboard.widget.addtakesqueryas an array plus dashboard and title positionals. Thetokenoption falls back to the stored login first, thenSENTRY_AUTH_TOKEN/SENTRY_TOKEN.SentryOptions.tokenJSDoc (sdk-types.ts): corrected the fallback order to matchsdk-invoke.tsanddb/auth.ts.SENTRY_HOSTno longer says OAuth login works with the variable alone. A self-hosted login still needssentry auth login --url.SENTRY_PLAIN_OUTPUTnow documents that0/falseforces formatted output.sentry cli feedback: the docs now say thatDO_NOT_TRACK=1andsentry cli defaults telemetry offalso turn off telemetry, which blocks feedback.Validation
pnpm --filter sentry run generate:schema,generate:docsandpnpm --filter sentry-cli-docs run build. All passed, and the committed skill files didn't change.distfound no broken internal links or anchors.lint,tsc --noEmit(after building mcp-core/mcp-server),check:fragments,check:docs-sectionsandcheck:env-coveragepassed.vitest(help, help-json, sdk-invoke,test/commands/cli) and thesentry-cli-docstests passed.via Junior system actor
scheduler.--
View Junior Session [Sentry]