Skip to content

docs(cli): Fix broken doc links and stale SDK examples - #1542

Merged
betegon merged 1 commit into
mainfrom
docs/cli-fix-broken-links-and-sdk-examples
Oct 19, 2026
Merged

betegon merged 1 commit into
mainfrom
docs/cli-fix-broken-links-and-sdk-examples

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

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

  • Broken links: pages are served with a trailing slash (/features/), so ./configuration/ resolved to /features/configuration/ and returned 404. Links in features.md, library-usage.md, self-hosted.md, the configuration and auth fragments, and the env var descriptions in env-registry.ts now use the right relative paths. The /installation/ link in library-usage.md now points to the installation page (getting-started), and the sentry cli defaults anchor now matches the generated heading. Checked against the built site: the new dist has no broken internal links or anchors (it had 14 before).
  • CLI README: added the Windows PowerShell installer (irm https://cli.sentry.dev/install.ps1 | iex). Fixed the library examples: sdk.issue.view takes the issue ID as a positional argument, and sdk.dashboard.widget.add takes query as an array plus dashboard and title positionals. The token option falls back to the stored login first, then SENTRY_AUTH_TOKEN / SENTRY_TOKEN.
  • SentryOptions.token JSDoc (sdk-types.ts): corrected the fallback order to match sdk-invoke.ts and db/auth.ts.
  • Env vars: SENTRY_HOST no longer says OAuth login works with the variable alone. A self-hosted login still needs sentry auth login --url. SENTRY_PLAIN_OUTPUT now documents that 0/false forces formatted output.
  • sentry cli feedback: the docs now say that DO_NOT_TRACK=1 and sentry cli defaults telemetry off also turn off telemetry, which blocks feedback.

Validation

  • Ran pnpm --filter sentry run generate:schema, generate:docs and pnpm --filter sentry-cli-docs run build. All passed, and the committed skill files didn't change.
  • A link check on the built dist found no broken internal links or anchors.
  • CLI lint, tsc --noEmit (after building mcp-core/mcp-server), check:fragments, check:docs-sections and check:env-coverage passed.
  • vitest (help, help-json, sdk-invoke, test/commands/cli) and the sentry-cli-docs tests passed.

via Junior system actor scheduler.

--

View Junior Session [Sentry]

@vercel

vercel Bot commented Oct 19, 2026

Copy link
Copy Markdown

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

1 Skipped Deployment
Project Deployment Actions Updated
sentry-local Skipped Skipped Oct 19, 2026 12:16pm UTC

Request Review

@sentry-junior sentry-junior Bot added the CLI Sentry CLI and CLI documentation label Oct 19, 2026
@BYK
BYK marked this pull request as ready for review October 19, 2026 12:50
@github-actions github-actions Bot added the risk: low PR risk score: low label Oct 19, 2026
@betegon
betegon merged commit 61b2218 into main Oct 19, 2026
27 checks passed
@betegon
betegon deleted the docs/cli-fix-broken-links-and-sdk-examples branch October 19, 2026 12:53

This branch was previously deployed

1 inactive deployment
Preview — 1eee27f4 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLI Sentry CLI and CLI documentation risk: low PR risk score: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants