Skip to content

Content Fixtures

This page exercises the default content surface that Sentry docs sites use most often. It should remain calm, dense, and easy to scan.

Documentation pages usually mix short conceptual paragraphs with precise implementation details. Links should be visible without pulling too much attention from surrounding text, like this reference to Sentry.

Inline code should hold up inside dense text: pnpm --filter @sentry/starlight-theme-playground dev. Long tokens should wrap instead of widening the page: SENTRY_EXAMPLE_ENVIRONMENT_VARIABLE_WITH_A_REALLY_LONG_NAME.

A link with parentheses should survive Markdown export, like Rust. Link-like inline code should stay literal: [do not rewrite](/content/).

Plain text that only looks like part of a link should stay literal: compare a](i) and b](i).

A link with code in its label should still rewrite: code label.

Inline HTML examples should not rewrite hrefs inside code: <a href="/content/">Content</a>.

HTML entities inside inline code should export decoded text: <section data-state=“open”>.

<div data-state="open">Example</div>
<pre>
Preserve indentation and blank lines.
</pre>
<a href="/content/">Tilde fenced content</a>
```html
<a href="/content/">Nested fence content</a>
```
  • Keep spacing compact enough for reference docs.
  • Preserve contrast for secondary text.
  • Avoid layout shifts when active sidebar links change.
  1. Install the theme package.
  2. Add the plugin to Starlight.
  3. Start the playground when changing styles.
Instructions for your Agent
You are working in a Sentry documentation project.

1. Read the repository instructions before editing.
2. Make the **smallest coherent change**.
3. Run the project checks and report the results.

Good documentation makes the common path obvious and the uncommon path discoverable.

SurfacePurposeRisk
NavigationSite orientationActive state contrast
MarkdownLong-form readingParagraph density
CodeCopyable examplesHorizontal overflow
TablesAPI detailsMobile overflow
namestring
Skill name or local path.
pathsarray
Files to include as glob patterns.
failOnseverity

Minimum severity to fail: critical, high, medium, low, info, or off.

remoteoptional

GitHub repository for remote skills, such as owner/repo or owner/repo@sha.

key-value-list.mdx
<dl class="sentry-key-value-list">
<div>
<dt>
<code>name</code>
<span class="sentry-property-meta">string</span>
</dt>
<dd>Skill name or local path.</dd>
</div>
<div>
<dt>
<code>remote</code>
<span class="sentry-property-meta">optional</span>
</dt>
<dd>
GitHub repository for remote skills, such as <code>owner/repo</code>.
</dd>
</div>
</dl>

Use api-link-card when a page needs a compact grid of next-step links. These cards also verify the Markdown exporter because Warden and vitest-evals use the same markup for reading paths.

Navigation

Check current page states, hover styles, and right-sidebar headings.

Responsive

Resize the viewport and confirm content never expands beyond the page.

fixture-card.mdx
<div class="fixture-grid not-content">
<div class="fixture-panel">
<strong>Navigation</strong>
<span>Check current page states, hover styles, and sidebar headings.</span>
</div>
<div class="fixture-panel">
<strong>Responsive</strong>
<span>Resize the viewport and confirm content stays inside the page.</span>
</div>
</div>

Text under an h3 should feel connected to the section without competing with h2 headings.

Smaller headings should still be legible in API-heavy pages.