write-docs

Create and update Abacus MDX documentation pages with frontmatter and build validation.

78|5|Updated Jan 6, 2026
One-click install
npx skills add https://github.com/getsentry/abacus --skill write-docs-getsentry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/getsentry/abacus/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/getsentry/abacus --skill write-docs-getsentry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation and maintenance of Abacus documentation pages, ensuring consistency with Astro Starlight patterns and keeping documentation in sync with code changes.

Core Features & Use Cases

  • Create new MDX pages in the docs site and add appropriate frontmatter.
  • Update existing pages to reflect code changes, API updates, or deployment notes.
  • Validate docs build by running the Astro/Starlight pipeline to catch broken links and misconfigurations.

Quick Start

Use the write-docs skill to add or update a docs page by creating an MDX file in docs/src/content/docs, ensure frontmatter is present with title, description, and sidebar order, then run the docs build locally with 'cd docs && pnpm build'.

Frequently Asked Questions about write-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create new MDX documentation pages with correct frontmatter?

MDX documentation pages require frontmatter with title, description, and sidebar order defined in the file header. This ensures consistency across the docs site and proper integration with the Astro Starlight build workflow.

How do I validate my Astro Starlight docs build locally?

Validate an Astro Starlight docs build locally by running 'cd docs && pnpm build'. This pipeline checks for broken links, misconfigurations, and frontmatter issues before deploying documentation updates.

What's the best way to keep documentation in sync with code changes?

Keeping documentation in sync with code changes involves updating existing MDX pages to reflect API updates or deployment notes. Automating this maintenance ensures docs stay accurate and aligned with the current codebase.

Do I need pnpm installed to build the docs site?

Yes, pnpm is required to build the docs site. The Astro/Starlight build workflow validates documentation by running the build pipeline with pnpm in the docs directory to catch configuration errors.

Why does my docs build fail after adding a new MDX page?

A docs build fails when new MDX pages lack required frontmatter fields like title, description, or sidebar order. Missing frontmatter breaks Astro Starlight patterns and causes pipeline validation errors during the build.