docs(seer): Iterate on seer/autofix/code-review docs for clarity and consistency#16835
docs(seer): Iterate on seer/autofix/code-review docs for clarity and consistency#16835
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
f119a18 to
d95ce94
Compare
a10458d to
b0c6a03
Compare
0088a88 to
4b8c08d
Compare
6ab9a6d to
3cb6447
Compare
| title: Root Cause Analysis | ||
| title: Seer Autofix | ||
| description: >- | ||
| Use Seer's Root Cause Analysis to automatically find the root cause of issues |
There was a problem hiding this comment.
| 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 |
| 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
When does this release? Do we want to publish these changes in tandem with that? What are the milestones for these changes?
There was a problem hiding this comment.
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.
sfanahata
left a comment
There was a problem hiding this comment.
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.
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:
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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