Skip to content

docs: add /sentry-get-started design brainstorm#202

Open
evanpurkhiser wants to merge 1 commit into
mainfrom
evanpurkhiser/docs-add-sentry-get-started-design-brainstorm
Open

docs: add /sentry-get-started design brainstorm#202
evanpurkhiser wants to merge 1 commit into
mainfrom
evanpurkhiser/docs-add-sentry-get-started-design-brainstorm

Conversation

@evanpurkhiser

@evanpurkhiser evanpurkhiser commented Jun 18, 2026

Copy link
Copy Markdown
Member

A working design doc for /sentry-get-started and the Sentry skill architecture behind it — the proposed single entrypoint that walks a user into whatever they actually need from Sentry through an agent, without burning their token budget guessing.

The directory holds three docs. use-cases.md is the user-story catalog (what people ask Sentry to do agentically). index.md captures the design principles (orient cheaply then let the user drive; close the loop by confirming events landed via MCP; aspire to do everything but be honest about current coverage), the cheap orientation probe, and the conditional capability menu. proposed-skills.md is where the skill design lives.

The notable shift in this version: the skill architecture moves from four layered skills (WHY/DO/HOW/USE — sentry-concepts/sentry-setup/sentry-sdk/sentry-workflow) to task-shaped skills plus a shared references/ library. The insight is that discovery (what the agent triggers on) wants to be task-shaped, while content factoring (not duplicating per-signal strategy across 19 platforms) wants to be layered — and we get both by making skills the tasks a user names (sentry-instrument, sentry-debug-issue, …) and demoting concepts and per-SDK code to reference documents. Each built skill is made self-contained by a build-time step: a per-skill references.yml declares which shared references to copy in, and a Python hydrate script copies them with a link-validator backstop, so source stays DRY while every shipped skill is complete.

proposed-skills.md defines the reference-library tree, the per-skill structure and manifest, and the full ~14-skill task set split into a first focus (/sentry-get-started, sentry-instrument, sentry-debug-issue) and a later focus, with an auditable use-case-to-skill coverage map. index.md is annotated where the older four-skill flows are pending a pass to the new shape.

This is a design artifact intended to inform the actual skill/command work, not a final spec. Decisions made and still-open questions are tracked at the bottom of index.md.

@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch from 1de4284 to b33eda9 Compare June 18, 2026 15:24
Comment thread SENTRY-GET-STARTED-DESIGN.md Outdated
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch 3 times, most recently from 373b23f to 5a6e075 Compare June 18, 2026 16:06
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch 3 times, most recently from bff52ac to c0fc04f Compare June 23, 2026 20:00
candidate for a future "create account" flow once the API/onboarding supports it.)* Once
they're signed up, they come back and connect the MCP.
- **"I have an account — help me connect Sentry via the MCP"** → walk them through `/mcp`
connect/auth, then re-run the probe.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MCP path skips orientation probe

Medium Severity

Step 0 requires re-running the full orientation probe after MCP connect/auth, but the master flowchart sends the post-connect path straight to ROUTE instead of back through PROBE. That omits the repo grep and find_projects signals needed for the new-vs-existing branch.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c0fc04f. Configure here.

Comment thread GETTING-STARTED-DESIGN/index.md Outdated
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch 2 times, most recently from fd468b1 to d545326 Compare June 23, 2026 20:18

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

There are 3 total unresolved issues (including 2 from previous reviews).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit d545326. Configure here.

Comment thread GETTING-STARTED-DESIGN/index.md Outdated
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch 9 times, most recently from 057122e to 2bd0473 Compare June 26, 2026 18:08
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch 2 times, most recently from 16180fc to 73462c1 Compare July 2, 2026 18:48
Comment thread skills-next/references/sdks/dotnet/tracing.md Outdated

For each signal the scope calls for:

1. **WHY (only when it helps the decision).** If the user is unsure *which* signal or *how much* to

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll tighten this up, it should react the concept for a instrumentation type when it's doing that instrumentation

Design notes for a single guided `/sentry-get-started` entry point: an
orientation probe that routes a user into first-error setup or the right
follow-on, the proposed skill set and reference layout, and the use cases
(first-time setup, adding a signal) it needs to cover.

Design docs only -- no skills or commands are wired up here.
@evanpurkhiser evanpurkhiser force-pushed the evanpurkhiser/docs-add-sentry-get-started-design-brainstorm branch from 73462c1 to 3f2f4a3 Compare July 9, 2026 18:31
Comment on lines +139 to +143
# skills/sentry-debug-issue/references.yml
needs:
- search-query-language.md
- concepts/{errors,tracing}.md
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The build script only warns about missing reference files instead of failing the build, leading to skills being shipped with broken documentation links.
Severity: HIGH

Suggested Fix

Implement the "backstop" validation described in the design document (proposed-skills.md:155-157) to scan for broken relative links in hydrated skills and fail the build if any are found. Additionally, create the missing search-query-language.md file or remove references to it.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: GETTING-STARTED-DESIGN/proposed-skills.md#L139-L143

Potential issue: The build script `hydrate-references.py` only issues a warning when a
referenced file is missing, instead of failing the build as intended by the design.
Specifically, the `sentry-debug-issue` skill references `search-query-language.md`,
which does not exist. The design also proposed a "backstop" validation to scan for
broken links and fail the build, but this was not implemented. As a result, the skill
will be shipped with broken documentation links, preventing the agent from accessing
required materials and breaking the documented procedure.

Also affects:

  • skills-next/skills/sentry-debug-issue/references.yml:2
  • skills-next/skills/sentry-debug-issue/SKILL.md
  • scripts/hydrate-references.py

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