SentryKnown publishergetsentry/abacus/.claude/skills/write-docs/SKILL.md

write-docs

Skill77 starsChanged 9 months agoApache-2.0View on GitHub

Create or update documentation pages for the Abacus docs site. Use when adding new documentation, updating existing pages, or ensuring docs stay in sync with code changes. Ensures pages follow Starlight patterns and build correctly.

We split this skill into the rules it gives an agent

9 rules. 0 are common, 4 are distinctive, and 5 are very specific to this project.

0
Common
Most of the 37 edited versions we read keep these.
4
Distinctive
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Create and maintain documentation for the Abacus docs site (Astro Starlight).
line 9
Very specific:
Read existing pages in docs/src/content/docs/ to understand patterns
line 13
Very specific:
Check docs/astro.config.mjs for sidebar structure
line 14
Very specific:
Create .mdx file in the appropriate directory
line 21
Distinctive:
Add required frontmatter (see below)
line 22
Distinctive:
Use existing pages as reference for component usage
line 23
Very specific:
Run cd docs && pnpm build to verify
line 24
Distinctive:
Read the current page first
line 28
Distinctive:
Keep paragraphs short - users skim
line 94

“Common” is measured: kept by at least 6 in 10 of the 37 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

Write Docs Skill

Create and maintain documentation for the Abacus docs site (Astro Starlight).

Before Starting

Read existing pages in docs/src/content/docs/ to understand patterns
Check docs/astro.config.mjs for sidebar structure
Understand the section you're adding to (getting-started, providers, cli, deployment, development)

Workflow

Adding a New Page

Create .mdx file in the appropriate directory
Add required frontmatter (see below)
Use existing pages as reference for component usage
Run cd docs && pnpm build to verify

Updating an Existing Page

Read the current page first
Make changes, preserving existing patterns
Run cd docs && pnpm build to verify

Frontmatter

Every page requires:

---
title: Page Title
description: One-line description for SEO
sidebar:
  order: 1  # Position within section
---

Key Rules

Links Must Include Base Path

Internal links need /abacus/ prefix (GitHub Pages requirement):

[Quick Start](/abacus/getting-started/quick-start/)  ✓
[Quick Start](/getting-started/quick-start/)          ✗

Import Components Before Use

import { Steps, Aside } from '@astrojs/starlight/components';

<Steps>
1. First step
2. Second step
</Steps>

<Aside type="tip">Helpful note</Aside>

Code Blocks Need Language Tags

```bash
pnpm cli sync


## Build Verification

**Always verify before committing:**

```bash
cd docs && pnpm build

Common errors:

Missing imports
Invalid frontmatter
Broken links (wrong path or missing /abacus/)

Style Guidelines

Imperative mood ("Run this" not "You should run")
Code examples over abstract descriptions
Keep paragraphs short - users skim
Tables for reference data (env vars, options)

Download now (ZIP)

Other versions38 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 38
tldraw/tldraw★ 51ksame name
tabler/tabler★ 42ksame name
videojs/video.js★ 40ksame name
PrefectHQ/prefect★ 24ksame name
comet-ml/opik★ 23ksame name
coder/coder★ 17ksame name
browseros-ai/BrowserOS★ 14ksame name
Agenta-AI/agenta★ 4.9ksame name
liveblocks/liveblocks★ 4.8ksame name
dzhng/jevgrep★ 2.9ksame name
28 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
Used alongsideProjects with it also use audit-choices, close-spec and 10 more.
Other files people use alongside this one.
- dzhngSkill
  audit-choices
  Audit the choices an implementing agent made, not its diff — a pure decision audit that traces the session's history into a choices ledger, changes no code, and never blocks an unsupervised run. Working code still embeds architecture the user never chose; surface it because future work inherits it. Use when the user wants to review the decisions the AI made on their behalf, before merging or committing AI-implemented work, when integrating a delegated subagent's pass, or when a fix "works" but might be a point fix.
  Also in 4 projects that use this
- dzhngSkill
  close-spec
  When a spec under specs/<feature>/ is done shipping (a write-spec build, or any planned task that produced a spec), archive it to specs/done/ and rewrite it from a build-plan into a durable rationale — the why, the principles, the invariants — pointing back to the real code for the how. Use when implementation has landed and the plan no longer matches what shipped, or the user says a feature/spec is finished. Pairs with [write-spec](../write-spec/SKILL.md) (the plan this closes) and [review](../review/SKILL.md) (run before closing).
  Also in 4 projects that use this
- transitive-bullshitSkill
  compare-screenshots
  Compare screenshots against the intended design, distinguishing approved references from historical baselines. Use for iterative implementation matching, before/after visual review, objective image telemetry, or checking a lone capture for flat, empty, or badly framed content.
  Also in 4 projects that use this
- LucasMatuszewskiSkill
  audit-agents
  Audit and maintain agent configuration files (.claude/agents, AGENTS.md, CLAUDE.md, agent-memory). Checks for duplicates, outdated info, naming conflicts, wrong technical facts, and files over 200 lines. Fixes all issues and commits.
  Also in 4 projects that use this
- rhnfzlSkill
  explore-unknowns
  Walk the user through mapping the unknowns of a task before, during, and after they build it, and hand them a four-quadrant map (settled ground, open decisions, taste, and landmines) they keep. Reach for this eagerly whenever a request is ambiguous or underspecified, the codebase or domain is unfamiliar, the user will "know it when they see it", a reference implementation must be understood before porting, a build-queue or architecture-changing task is about to start, a mid-build deviation needs capturing, or a finished change needs buy-in or verified understanding before merge. Trigger even when the skill is not named: "do a blindspot pass", "find my unknown unknowns", "interview me about this change", "brainstorm the approach for a task I am about to build", "help me scope this", "what am I missing here", "plan this before I build", "I know nothing about X in this codebase". When a territory profile is present it reads memory and the graph first and feeds the map into the build pipeline; without one it degrades to a plain general map. Not for trivial or mechanical tasks with clear acceptance criteria, single-fact lookups, pure debugging of a known symptom, or pure code review, those have their own tools. Do not use it to run the build itself; the map is the deliverable and implementation remains a separate task, whether it has not started or is already underway.
  Also in 4 projects that use this
- isLinXuSkill
  eval-skills
  AI Agent Skill unit testing framework. A framework-agnostic toolkit for discovering, scaffolding, selecting, evaluating, and reporting on AI skills. Use this skill to assess skill quality before production, compare candidate skills on the same benchmark, enforce quality gates in CI/CD, and generate human-readable evaluation reports.
  Also in 4 projects that use this
- +5 more from dzhng
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- db-migrateSkill
- ui-designSkill
- write-testsSkill
- write-tipSkill

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free

9 rules. 0 are common, 4 are distinctive, and 5 are very specific to this project.

Write Docs Skill

Before Starting

Workflow

Adding a New Page

Updating an Existing Page

Frontmatter

Key Rules

Links Must Include Base Path

Import Components Before Use

Code Blocks Need Language Tags

Style Guidelines

Word for word · 0

Edited · 0

Wrote their own version · 38

audit-choices

close-spec

compare-screenshots

audit-agents

explore-unknowns

eval-skills

Does it work?

No reviews yet

Your trail

Now do this for your own.