diff --git a/docs/product/ai-in-sentry/sentry-prevent-ai/index.mdx b/docs/product/ai-in-sentry/sentry-prevent-ai/index.mdx index a0599d4bc4e4b5..b7ffd0f553d972 100644 --- a/docs/product/ai-in-sentry/sentry-prevent-ai/index.mdx +++ b/docs/product/ai-in-sentry/sentry-prevent-ai/index.mdx @@ -1,28 +1,32 @@ --- title: Sentry Prevent AI sidebar_order: 30 -description: "Get code reviews and new tests for better code and coverage using Sentry Prevent AI." +description: "AI-assisted code review and test generation to improve quality and test coverage." --- -Sentry Prevent AI is a generative AI assistant developed by Sentry. It helps you generate new tests for uncovered code and reviews your code changes, offering suggestions for improvement before merging pull requests. +Sentry Prevent AI is a generative AI assistant developed by Sentry that reviews your pull requests, suggests improvements, and generates tests for uncovered code before you merge. - Sentry Prevent AI is currently in beta. Beta features are still a work in progress and may have bugs. Please join the [Discord conversation](https://discord.com/channels/621778831602221064/1385700674557444190) to share your feedback. + Sentry Prevent AI is currently in beta. Beta features are + still a work in progress and may have bugs. Please join the [Discord + conversation](https://discord.com/channels/621778831602221064/1385700674557444190) + to share your feedback. ## Getting Started -To enable Sentry Prevent AI in your GitHub organization or on specific repositories, you need to install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry). This allows the assistant to analyze pull requests, provide insights, and write tests. +1. Install the [Seer by Sentry app](https://github.com/apps/seer-by-sentry) in your GitHub organization or specific repositories. +2. Enable these required settings in your Sentry [organization settings](https://sentry.io/orgredirect/settings/:orgslug/): + - `Show Generative AI Features` + - `Enable PR Review and Test Generation` -If you're not an admin, copy the Sentry Prevent AI GitHub App Integration link and share it with your organization's admin or owner to install it. - -**Note:** Both `Show Generative AI Features` and `Enable PR Review and Test Generation` settings must be enabled in your [organization settings](https:sentry.io/settings/organization/) to run Sentry Prevent AI on your pull requests. +If you're not an admin, share the Sentry Prevent AI GitHub App Integration link with your organization's admin or owner to install. ## Sentry Prevent AI Commands After installing the app, use these commands in your pull request comments: -- `@sentry review` - The assistant will review the PR and make suggestions. +- `@sentry review` - The assistant will review the PR and make suggestions. - `@sentry generate-test` - The assistant will generate tests for your PR. @@ -34,15 +38,14 @@ Once you have added a comment, the assistant will reply, acknowledging the reque - **What data does Sentry Prevent need access to for the AI system to function, and what information is sent to third-party AI providers?** - Sentry Prevent requires access to your pull requests, including PR metadata, repository information, file names, directory structures, and code diffs. The file names, code diffs, and PR descriptions are sent to the AI provider for analysis. + Sentry Prevent AI works by analyzing pull request details, such as metadata, file names, directory structure, and code changes. Only file names, code diffs, and PR descriptions are shared with the AI provider for analysis. - **Does Sentry Prevent run anywhere outside of GitHub, and does it run in the background?** - Sentry Prevent AI only runs on GitHub, and only runs when triggered by a comment. + Sentry Prevent AI only runs on GitHub, and only runs when triggered by a comment. You can learn more about AI privacy and security [here](/product/ai-in-sentry/ai-privacy-and-security/). - **Why aren't `@sentry` commands working?** - Sentry Prevent AI will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https:sentry.io/settings/organization/), if you have not already enabled them. Once enabled, try `@sentry review` or `@sentry generate-test` again to run Prevent AI. - + Sentry Prevent AI will respond with a message to enable the `Show Generative AI Features` and `Enable PR Review and Test Generation` settings in your [organization settings](https://sentry.io/orgredirect/settings/:orgslug/), if you have not already enabled them. Once enabled, try `@sentry review` or `@sentry generate-test` again to run Prevent AI.