Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .agents/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Auto-generated by dotagents. Do not edit.
# Managed skills (installed by dotagents)
/skills/brand-guidelines/
16 changes: 15 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,25 @@ When writing requirements in `develop-docs/`:
</Alert>
```

## Content Authoring

- **ALWAYS** run `/brand-guidelines` to audit any user-facing content before committing. See `.agents/skills/brand-guidelines/SKILL.md`
- Use `docs-review` skill for Sentry style and voice review. See `.claude/skills/docs-review/SKILL.md`
- Use `technical-docs` skill when writing or reviewing SDK documentation. See `.claude/skills/technical-docs/SKILL.md`

## LLM-Friendly MD Exports

- Every page at `docs.sentry.io/<path>` has a `.md` export at `docs.sentry.io/<path>.md`
- `scripts/generate-md-exports.mjs` generates these as a post-build step
- Frontmatter metadata (title, description, URL) is emitted as a YAML frontmatter block in MD exports — pages missing descriptions lose LLM relevance signal
- MDX override templates live in `md-overrides/`
- Architecture spec: `specs/llm-friendly-docs.md`

## Plan Mode

- Make the plan extremely concise. Sacrifice grammar for the sake of concision.
- At the end of each plan, give me a list of unresolved questions to answer, if any.

## Pull Request generation
## Pull Request generation

Use .github/PULL_REQUEST_TEMPLATE.md and add Co-Authored-By: Claude
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
develop: setup-git
[ -f .env.development ] || cp .env.example .env.development
pnpm install
npx @sentry/dotagents install

setup-git:
ifneq (, $(shell which pre-commit))
Expand Down
10 changes: 10 additions & 0 deletions agents.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Auto-generated by dotagents. Do not edit.
version = 1

[skills.brand-guidelines]
source = "getsentry/skills"
resolved_url = "https://github.com/getsentry/skills.git"
resolved_path = ".agents/skills/brand-guidelines"
commit = "5bf1b9870096afd55e62069514c7e77d4e62b5f0"
integrity = "sha256-OI4bxji4am79cV/3TNDVUfsnt6L2HBysG7epE4HFkVI="

8 changes: 8 additions & 0 deletions agents.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version = 1
# Check skills into git so collaborators get them without running 'dotagents install'.
# Set to true (or remove) to gitignore managed skills instead.
gitignore = true

[[skills]]
name = "brand-guidelines"
source = "getsentry/skills"
2 changes: 2 additions & 0 deletions docs/contributing/environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Next, navigate into the cloned repo and run the following to install dependencie
make
```

This also installs agent skills via `@sentry/dotagents` for AI-assisted development workflows.

Now, run the development webserver (depending on the docs you want to run):

```bash
Expand Down
3 changes: 2 additions & 1 deletion docs/contributing/pages/llm-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ Our existing documentation principles naturally support LLM consumption:

When writing documentation, keep in mind:

- **Frontmatter descriptions** appear in section listings and help LLMs understand page purpose
- **Frontmatter descriptions are included in MD exports** as a YAML frontmatter block (with title, description, and canonical URL). Pages without a `description` in their frontmatter lose this LLM relevance signal — LLM agents read the first few lines to decide if a page is useful, so a good description helps them prioritize correctly.
- **Code examples** should be complete and runnable - LLMs often copy them directly
- **Avoid ambiguous references** like "click the button above" that require visual context
- Pages with `noindex: true` are excluded from search and LLM discovery
- **Hub pages** (pages that only contain `<PageGrid />`) rely on their frontmatter `description` for context in MD exports — make sure they have one
1 change: 1 addition & 0 deletions docs/platforms/android/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Android
description: "Learn how to set up Sentry's Android SDK for error monitoring and performance tracking."
caseStyle: camelCase
supportLevel: production
sdk: sentry.java.android
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/apple/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Apple
description: "Learn how to set up Sentry's Apple SDK for error monitoring and performance tracking."
sdk: sentry.cocoa
caseStyle: camelCase
supportLevel: production
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/godot/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Godot Engine
description: "Learn how to set up Sentry's Godot Engine SDK for error monitoring and performance tracking."
caseStyle: snake_case
supportLevel: production
sdk: sentry.godot
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/kotlin/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Kotlin
description: "Learn how to set up Sentry's Kotlin SDK for error monitoring and performance tracking."
caseStyle: camelCase
supportLevel: production
categories:
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/nintendo-switch/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Nintendo Switch
description: "Learn how to set up Sentry's Nintendo Switch SDK for error monitoring and performance tracking."
caseStyle: snake_case
supportLevel: production
sdk: sentry.nintendo-switch
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/playstation/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: PlayStation
description: "Learn how to set up Sentry's PlayStation SDK for error monitoring and performance tracking."
caseStyle: snake_case
supportLevel: production
sdk: sentry.playstation
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/powershell/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: PowerShell
description: "Learn how to set up Sentry's PowerShell SDK for error monitoring and performance tracking."
caseStyle: PascalCase
supportLevel: production
sdk: sentry.dotnet.powershell
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/rust/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Rust
description: "Learn how to set up Sentry's Rust SDK for error monitoring and performance tracking."
sdk: sentry.rust
caseStyle: snake_case
supportLevel: production
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/unity/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Unity
description: "Learn how to set up Sentry's Unity SDK for error monitoring and performance tracking."
caseStyle: PascalCase
supportLevel: production
sdk: sentry.dotnet.unity
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/unreal/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Unreal Engine
description: "Learn how to set up Sentry's Unreal Engine SDK for error monitoring and performance tracking."
caseStyle: PascalCase
supportLevel: production
sdk: sentry.unreal
Expand Down
1 change: 1 addition & 0 deletions docs/platforms/xbox/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Xbox
description: "Learn how to set up Sentry's Xbox SDK for error monitoring and performance tracking."
caseStyle: snake_case
supportLevel: production
sdk: sentry.xbox
Expand Down
Loading
Loading