Skip to content

Commit 118bb6e

Browse files
ref(llm-rules-platform): Add a note saying to keep app's and doc's rules sync (#13944)
Contributes to https://linear.app/getsentry/issue/TET-509/add-onboarding-content-for-popular-platforms Related PR getsentry/sentry#93006
1 parent ef8b124 commit 118bb6e

File tree

4 files changed

+13
-0
lines changed

4 files changed

+13
-0
lines changed

platform-includes/llm-rules-platform/_default.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Sentry provides a set of rules you can use to help your LLM use Sentry correctly. Copy this file and add it to your projects rules configuration. When created as a rules file this should be placed alongside other editor specific rule files. For example, if you are using Cursor, place this file in the `.cursorrules` directory.
44

5+
{/* ATTENTION: The rules defined here must match those in the app's onboarding documentation (see: https://github.com/getsentry/sentry/blob/master/static/app/gettingStartedDocs/javascript/javascript.tsx).
6+
If you make any changes, please update the getting started doc accordingly. */}
7+
8+
59
````markdown {filename:rules.md}
610
These examples should be used as guidance when configuring Sentry functionality within a project.
711

platform-includes/llm-rules-platform/javascript.nextjs.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Sentry provides a set of rules you can use to help your LLM use Sentry correctly. Copy this file and add it to your projects rules configuration. When created as a rules file this should be placed alongside other editor specific rule files. For example, if you are using Cursor, place this file in the `.cursorrules` directory.
44

5+
{/* ATTENTION: The rules defined here must match those in the app's onboarding documentation (see: https://github.com/getsentry/sentry/blob/master/static/app/gettingStartedDocs/javascript/nextjs.tsx).
6+
If you make any changes, please update the getting started doc accordingly. */}
7+
58
````markdown {filename:rules.md}
69
These examples should be used as guidance when configuring Sentry functionality within a project.
710

platform-includes/llm-rules-platform/javascript.node.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Sentry provides a set of rules you can use to help your LLM use Sentry correctly. Copy this file and add it to your projects rules configuration. When created as a rules file this should be placed alongside other editor specific rule files. For example, if you are using Cursor, place this file in the `.cursorrules` directory.
44

5+
{/* ATTENTION: The rules defined here must match those in the app's onboarding documentation (see: https://github.com/getsentry/sentry/blob/master/static/app/gettingStartedDocs/node/node.tsx).
6+
If you make any changes, please update the getting started doc accordingly. */}
7+
58
````markdown {filename:rules.md}
69
These examples should be used as guidance when configuring Sentry functionality within a project.
710

platform-includes/llm-rules-platform/javascript.react.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Sentry provides a set of rules you can use to help your LLM use Sentry correctly. Copy this file and add it to your projects rules configuration. When created as a rules file this should be placed alongside other editor specific rule files. For example, if you are using Cursor, place this file in the `.cursorrules` directory.
44

5+
{/* ATTENTION: The rules defined here must match those in the app's onboarding documentation (see: https://github.com/getsentry/sentry/blob/master/static/app/gettingStartedDocs/javascript/react.tsx).
6+
If you make any changes, please update the getting started doc accordingly. */}
7+
58
````markdown {filename:rules.md}
69
These examples should be used as guidance when configuring Sentry functionality within a project.
710

0 commit comments

Comments
 (0)