create-documentation

Generate markdown documentation for a module or feature

Quality

57%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.opencode/skills/create-documentation/SKILL.md

You are creating proper markdown documentation for a module or feature in the library.

Read WRITING_STYLE.md first for tone, formatting conventions, and anti-patterns to avoid.

Your Task

Identify the scope - Based on the conversation context, determine what module, feature, or file needs documentation. Ask the user if unclear.
Read the source code - Understand the public API, types, and behavior
Read existing docs - Check content/docs/ for documentation to update
Write comprehensive documentation - Create or update MDX docs

Documentation Structure

This project uses Fumadocs for documentation. All docs live in content/docs/ as MDX files.

content/docs/
├── index.mdx              # Landing page
├── meta.json              # Root navigation order
├── getting-started/       # Quickstart guides
│   ├── installation.mdx
│   ├── create-pdf.mdx
│   └── parse-pdf.mdx
├── guides/                # Feature guides
│   ├── drawing.mdx
│   ├── encryption.mdx
|   |-- ...
├── api/                   # API reference
│   ├── pdf.mdx
│   ├── pdf-page.mdx
│   ├── pdf-form.mdx
│   ├── ...
├── concepts/              # Conceptual docs
│   ├── pdf-structure.mdx
│   ├── object-model.mdx
│   └── incremental-saves.mdx
├── advanced/              # Advanced topics
│   └── library-authors.mdx
└── migration/             # Migration guides
    └── from-pdf-lib.mdx

Where to Put Documentation

Type	Location	When to use
API Reference	`content/docs/api/<class>.mdx`	Documenting a class like `PDF`, `PDFPage`, `PDFForm`
Feature Guide	`content/docs/guides/<feature>.mdx`	How-to guides for features (forms, signatures, etc.)
Concept	`content/docs/concepts/<topic>.mdx`	Explaining PDF concepts (structure, objects, etc.)
Getting Started	`content/docs/getting-started/`	Installation and first steps

Navigation (meta.json)

Each directory has a meta.json that controls navigation order:

{
  "title": "API Reference",
  "pages": [
    "index",
    "---Classes---",
    "pdf",
    "pdf-page",
    "pdf-form",
    "annotations",
    "---Other---",
    "errors"
  ]
}

Use ---Label--- for section dividers
Order determines sidebar appearance

MDX File Format

---
title: ModuleName
description: Brief description for SEO and previews.
---

# ModuleName

Brief description of what this module does and when to use it.

<Callout type="warn" title="my title">
  Use callouts sparingly for important warnings or beta features.
</Callout>

## Quick Start

\`\`\`typescript
import { PDF } from "@libpdf/core";
// Minimal working example
\`\`\`

---

## methodName(options)

Description of what the method does.

| Param        | Type     | Default  | Description    |
| ------------ | -------- | -------- | -------------- |
| `param`      | `string` | required | What it does   |
| `[optional]` | `number` | `10`     | Optional param |

**Returns**: `ReturnType`

\`\`\`typescript
// Usage example
\`\`\`

---

## Types

### TypeName

\`\`\`typescript
interface TypeName {
property: string;
}
\`\`\`

Fumadocs Components

<Callout type="info">Informational note</Callout>
<Callout type="warn">Warning message</Callout>
<Callout type="error">Error/danger message</Callout>

Guidelines

See WRITING_STYLE.md for complete guidelines. Key points:

Tone: Direct, second-person, no emojis
Examples: Progressive complexity, all must be valid TypeScript
Tables: Use Sharp-style nested parameter tables (see WRITING_STYLE.md)
Callouts: Use sparingly for warnings, beta features, security
Cross-references: Link related docs, add "See Also" sections
Navigation: Update meta.json when adding new pages

Process

Explore the code - Read source files to understand the API
Check existing docs - Look in content/docs/ for related pages
Identify the audience - Who will read this? What do they need?
Draft the structure - Outline sections before writing
Write content - Fill in each section with examples
Update navigation - Add to relevant meta.json if new page
Add cross-references - Link from related docs

Begin

Analyze the conversation context to determine the documentation scope, read the relevant source code, and create comprehensive MDX documentation in content/docs/.

Repository: LibPDF-js/core
Path: .opencode/skills/create-documentation/SKILL.md
Commit: 36bf165

Last updated: 2 days ago
First committed: 6 months ago

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.