Skip to content

docs(init): add documentation and experimental notice for sentry init#530

Merged
betegon merged 2 commits intomainfrom
docs/sentry-init-documentation
Mar 23, 2026
Merged

docs(init): add documentation and experimental notice for sentry init#530
betegon merged 2 commits intomainfrom
docs/sentry-init-documentation

Conversation

@betegon
Copy link
Member

@betegon betegon commented Mar 23, 2026

Summary

Adds complete documentation for the sentry init command and surfaces its experimental status.

docs/src/content/docs/commands/init.md

  • Adds experimental callout at the top
  • Notes that sentry init works out of the box from the repo root with no arguments
  • Fixes usage signature to include [target] positional
  • Adds "Target syntax" section documenting all org/project combinations (acme/, acme/my-app, my-app, auto-detect)
  • Adds missing --team / -t flag to options table
  • Expands features list to all 10 supported values (errors, tracing, logs, replay, metrics, profiling, sourcemaps, crons, ai-monitoring, user-feedback)
  • Adds examples for target syntax and --team

src/commands/init.ts

  • Prepends experimental warning to fullDescription (shown in sentry init --help)
  • Updates brief to flag the command as experimental in command listings

Test plan

  • sentry init --help — confirm experimental notice and all flags appear
  • Review rendered docs page for init

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

github-actions bot commented Mar 23, 2026

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).


Bug Fixes 🐛

Event

  • Detect org/ISSUE-SHORT-ID in event view single-arg path (CLI-9K) by BYK in #529
  • Auto-redirect issue short IDs in event view (CLI-JR) by BYK in #524

Other

  • (api) Strip api/0/ prefix and exclude NodeSystemError integration (CLI-K1) by BYK in #523
  • (dashboard) Add missing datasets to agent guidance by betegon in #522
  • Handle invalid URLs gracefully in response cache (CLI-GC) by BYK in #528
  • Avoid double-prefixing in buildCommandHint for slashed args (CLI-8C) by BYK in #527
  • Handle full short IDs and numeric IDs in multi-slash issue args (CLI-KC, CLI-B6) by BYK in #526
  • Auto-recovery for wrong entity types across commands (CLI-G6, CLI-K6, CLI-JR) by BYK in #525

Documentation 📚

  • (init) Add documentation and experimental notice for sentry init by betegon in #530

Internal Changes 🔧

  • Regenerate skill files by github-actions[bot] in 22b5281d

🤖 This preview updates automatically when you update the PR.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 23, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://cli.sentry.dev/pr-preview/pr-530/

Built to branch gh-pages at 2026-03-23 14:21 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions
Copy link
Contributor

Codecov Results 📊

126 passed | Total: 126 | Pass Rate: 100% | Execution Time: 0ms

📊 Comparison with Base Branch

Metric Change
Total Tests
Passed Tests
Failed Tests
Skipped Tests

✨ No test changes detected

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 1076 uncovered lines.
✅ Project coverage is 95.81%. Comparing base (base) to head (head).

Coverage diff
@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
+ Coverage    95.81%    95.81%        —%
==========================================
  Files          185       185         —
  Lines        25679     25679         —
  Branches         0         0         —
==========================================
+ Hits         24603     24603         —
- Misses        1076      1076         —
- Partials         0         0         —

Generated by Codecov Action

@betegon betegon merged commit 88b6f36 into main Mar 23, 2026
23 checks passed
@betegon betegon deleted the docs/sentry-init-documentation branch March 23, 2026 14:34
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