Skip to content

docs(seer): Iterate on seer/autofix/code-review docs for clarity and consistency#16835

Open
ryan953 wants to merge 7 commits intomasterfrom
ryan953/seer-docs
Open

docs(seer): Iterate on seer/autofix/code-review docs for clarity and consistency#16835
ryan953 wants to merge 7 commits intomasterfrom
ryan953/seer-docs

Conversation

@ryan953
Copy link
Member

@ryan953 ryan953 commented Mar 9, 2026

DESCRIBE YOUR PR

Updates the names and language we use to describe Aufofix and Code Review which are part of the Seer addon.

Pages you should take a look at in the preview env:

  • / -> "Fix Bugs Faster with Seer" section
  • /product/ai-in-sentry/
  • /product/ai-in-sentry/seer/
  • /product/ai-in-sentry/seer/issue-autofix/
  • /product/ai-in-sentry/seer/code-review/

Here's a guide to help:

  • Sentry overall has the option to disable AI features, including Seer branded features. “Show Generative AI Features”
  • Seer overall has the option to disable code-generation.
    • This prevents workflow steps that specifically output PRs from running. Chat interfaces, where you can convince the bot to output anything, have no restrictions (however you would need to copy+paste manually).
  • Within the Autofix workflow there are steps: Triage, Summary, RCA, Solution, Create PR
  • The ‘fix’ part of Autofix workflow is powered by a Coding Agent, currently one of: Seer, Cursor, Claude (coming soon), Copilot.
    • Users can drive this workflow manually by cilcking buttons in the UI, choosing a different coding agent for each step.
  • The ‘auto’ part of Autofix is powered by org-level agents that can run in the background, like: Seer, Cursor, Claude.
    • Copilot is a user-level agent, it is required for a user to click a button to trigger it each time.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Mar 9, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 11, 2026 9:41pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Mar 11, 2026 9:41pm

Request Review

@ryan953 ryan953 changed the title Ryan953/seer docs docs(seer): Iterate on seer/autofix/code-review docs for clarity and consistency Mar 9, 2026
@ryan953 ryan953 force-pushed the ryan953/seer-docs branch from a10458d to b0c6a03 Compare March 10, 2026 21:45
title: Root Cause Analysis
title: Seer Autofix
description: >-
Use Seer's Root Cause Analysis to automatically find the root cause of issues
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Use Seer's Root Cause Analysis to automatically find the root cause of issues
Use Seer's Autofix to automatically find the root cause of issues

Comment on lines +31 to +33
3. Connect projects to repositories in [Seer Project Settings](https://sentry.io/orgredirect/organizations/:orgslug/settings/seer/projects/). Seer will use the repositories connected to the project to perform Root Cause Analysis and Code Generation.

3. Optionally enable [PR creation](https://sentry.io/orgredirect/organizations/:orgslug/settings/seer/repos/) and/or delegate to a [coding agent](https://sentry.io/orgredirect/organizations/:orgslug/settings/seer/projects/#coding-agents).
Copy link
Contributor

Choose a reason for hiding this comment

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

If I turn off PR creation, I'm not turning off code generation, right? It feels like the two of these things are conflated in the project a little bit.

Copy link
Member Author

Choose a reason for hiding this comment

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

correct yes.

  • Sentry overall has the option to disable AI features, including Seer branded features. “Show Generative AI Features”
  • Seer overall has the option to disable code-generation.
    • This prevents workflow steps that specifically output PRs from running. Chat interfaces, where you can convince the bot to output anything, have no restrictions (however you would need to copy+paste manually).
  • Within the Autofix workflow there are steps: Triage, Summary, RCA, Solution, Create PR
    • You can configure the Autofix workflow to do the Create PR step automatically, or not do that step.

If you want to take a stab at getting that kind of thing into the docs i'd appreciate the boost.

- [**Coding Agents**](#coding-agents): Delegate Seer's analysis to an external coding agent for further debugging and fixes
- [**Root Cause Analysis**](#root-cause-analysis): Automatically scan issues as they come into Sentry, feeding additional context to your alerts and automating triage.
- [**PR Creation**](#pr-creation): Autofix your issues by using the root cause analysis to generate a code fix and create a PR.
- [**Coding Agents**](#coding-agents): Delegate Seer's analysis to an external coding agent for debugging and fixes.
Copy link
Contributor

Choose a reason for hiding this comment

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

When does this release? Do we want to publish these changes in tandem with that? What are the milestones for these changes?

Copy link
Member Author

Choose a reason for hiding this comment

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

The workflow and these steps are already released, afaik we're on v2 of the UI, and v3 is coming, but the shape of the workflow has been like this for a while and isn't changing at this time.

The docs here are so far pretty generic too and don't yet describe how you can skip some steps, re-run previous ones with a different LLM, stuff like that.

tl/dr: no milestone to sync up with. IMO the way i understand the system at a code level doesn't match with the current docs, so i'm trying to update the description to match.

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

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

Generally looks good, but I have questions about when we want to release this and how we're choosing to use these terms in the product and beyond. Will take this to the Seer channel for convo too.

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.

2 participants