documentation

Automated documentation generation from code, API schemas, and metadata with versioning, search, and interactive examples.

Overview

The documentation primitive automatically generates and maintains documentation from your code, APIs, and data models with support for MDX, OpenAPI, and custom formats.

Quick Example

import { documentation } from 'sdk.do'

// Generate API docs from OpenAPI
const apiDocs = await documentation.generate({
  source: 'openapi',
  spec: './openapi.yaml',
  output: './docs/api',
})

// Generate from TypeScript
const sdkDocs = await documentation.generate({
  source: 'typescript',
  files: ['./src/**/*.ts'],
  output: './docs/sdk',
})

// Create custom doc
const guide = await documentation.create({
  title: 'Getting Started Guide',
  path: '/guides/getting-started',
  content: `
    # Getting Started

    This guide will help you get up and running.
  `,
})

// Search documentation
const results = await documentation.search('authentication')

Core Capabilities

Auto-Generation - Generate docs from code, schemas, and APIs
Multiple Formats - MDX, Markdown, OpenAPI, TypeDoc
Versioning - Track documentation versions with code
Search - Full-text search across all documentation
Interactive Examples - Live code examples and playgrounds

Access Methods

SDK

TypeScript/JavaScript library for documentation

await documentation.generate({ source: 'typescript', files: ['./src/**/*.ts'] })

→ SDK Documentation

CLI

Command-line tool for documentation operations

do docs generate --source typescript --files "./src/**/*.ts"

→ CLI Documentation

API

REST/RPC endpoints for documentation

curl -X POST https://api.do/v1/documentation/generate -d '{"source":"typescript"}'

→ API Documentation

MCP

Model Context Protocol for AI-driven documentation

Generate TypeScript documentation from all files in ./src directory

→ MCP Documentation

templates - Documentation templates
storage - Documentation storage
searches - Documentation search

documentation

On this page