Skip to content
@libar-dev

Getting Started

Installation

Section titled “Installation”
Terminal window
npm install @libar-dev/delivery-process

Quick Setup

Section titled “Quick Setup”

1. Create a configuration file

Section titled “1. Create a configuration file”
delivery-process.config.ts
import { defineConfig } from '@libar-dev/delivery-process/config';


export default defineConfig({
  preset: 'generic',
});

2. Annotate your source files

Section titled “2. Annotate your source files”

Add the @docs opt-in marker to any TypeScript file you want to include:

/**
 * @docs
 * @docs-category core
 * @docs-extract-shapes UserSchema
 *
 * ## User Management
 *
 * Handles user creation and validation.
 */

3. Generate documentation

Section titled “3. Generate documentation”
Terminal window
npx generate-docs

4. Query delivery state

Section titled “4. Query delivery state”
Terminal window
npx process-api overview
npx process-api context MyPattern --session implement

Next Steps

Section titled “Next Steps”