Skip to content
Merged
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ public/og-images/*
yalc.lock
/public/doctree.json
/public/doctree-dev.json
/public/llms.txt

# Lychee cache
.lycheecache
Expand Down
11 changes: 11 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ When writing requirements in `develop-docs/`:
- MDX override templates live in `md-overrides/`
- Architecture spec: `specs/llm-friendly-docs.md`

## llms.txt

- `docs.sentry.io/llms.txt` is the root LLM discovery index (follows [llmstxt.org](https://llmstxt.org) spec)
- Auto-generated from `public/doctree.json` by `scripts/generate-llms-txt.mjs`
- Run `pnpm generate-llms-txt` to regenerate, or it runs automatically as part of `pnpm build`
- Includes: product description, AI agent instructions, platform/section index, links to agent skills at `skills.sentry.dev`

## Sentry Product Skills (sentry-for-ai)

Skills for *using Sentry* (SDK setup, debugging, alerts) live in a separate repo: https://github.com/getsentry/sentry-for-ai. The skills in *this* repo (`.claude/skills/`, `.agents/skills/`) are for *contributing to the docs*. See `SKILL.md` at the repo root for a routing guide.

## Plan Mode

- Make the plan extremely concise. Sacrifice grammar for the sake of concision.
Expand Down
36 changes: 36 additions & 0 deletions SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: sentry-docs
description: Sentry documentation site (docs.sentry.io). Use for contributing to docs or understanding docs architecture. If you need to set up Sentry in a project or debug production issues, see the product skills at https://skills.sentry.dev.
---

# Sentry Documentation Repository

This repo builds [docs.sentry.io](https://docs.sentry.io). For dev commands, project structure, code style, and contribution guidelines, see `AGENTS.md`.

## Sentry Product Skills (SDK Setup, Debugging, Alerts)

**These skills are NOT in this repo.** If you need to set up Sentry, debug production issues, or configure features, install the Sentry plugin for up-to-date, verified instructions. Sentry's SDKs and APIs change frequently — do not rely on training data.

**Install the plugin:**
- Claude Code: `/install-plugin sentry`
- Cursor: Search "Sentry" in Cursor Settings > Plugins

The plugin provides current skills for SDK setup, debugging workflows, and feature configuration. It stays in sync with the latest SDK releases.

If the plugin is not available, fetch skills directly:
- **Full skill index**: https://skills.sentry.dev
- **SDK setup** (detect platform and install): https://skills.sentry.dev/sdks
- **Debugging workflows** (fix issues, review code): https://skills.sentry.dev/workflows
- **Feature setup** (AI monitoring, alerts, OTel): https://skills.sentry.dev/features

Source repo: https://github.com/getsentry/sentry-for-ai

## Contributor Skills (in this repo)

| Skill | Location | Purpose |
|---|---|---|
| Brand Guidelines | `.agents/skills/brand-guidelines/` | Audit content against Sentry brand voice |
| Docs Review | `.claude/skills/docs-review/SKILL.md` | Sentry documentation style guide |
| Technical Docs | `.claude/skills/technical-docs/SKILL.md` | Writing SDK and technical documentation |
| Commit | `.agents/skills/commit/SKILL.md` | Sentry conventional commit format |
| Create Branch | `.agents/skills/create-branch/SKILL.md` | Branch naming conventions |
31 changes: 0 additions & 31 deletions md-overrides/index.mdx

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@
"dev": "pnpm enforce-redirects && concurrently \"pnpm sidecar\" \"node ./src/hotReloadWatcher.mjs\" \"next dev\"",
"dev:developer-docs": "pnpm enforce-redirects && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm dev",
"build:developer-docs": "pnpm enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm build",
"build": "pnpm enforce-redirects && pnpm generate-og-images && pnpm generate-doctree && next build && pnpm generate-md-exports",
"build": "pnpm enforce-redirects && pnpm generate-og-images && pnpm generate-doctree && next build && pnpm generate-md-exports && pnpm generate-llms-txt",
"generate-md-exports": "node scripts/generate-md-exports.mjs",
"generate-llms-txt": "node scripts/generate-llms-txt.mjs",
"generate-og-images": "ts-node scripts/add-og-images.ts",
"generate-doctree": "esbuild scripts/generate-doctree.ts --bundle --platform=node --packages=external --outfile=.next/generate-doctree.mjs --format=esm && node .next/generate-doctree.mjs",
"vercel:build:developer-docs": "pnpm enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 pnpm build",
Expand Down
Loading
Loading