@apivexa/planner

Converts API analysis into a structured documentation plan.

Part of ApiVexa — AI-powered API User Guide Generator.

Install

npm install @apivexa/planner

What it does

The planner sits between @apivexa/analysis and @apivexa/generator. It decides:

• Which sections to include (only relevant ones — empty sections are never created)
• The order of sections
• Which endpoints go into which section
• Whether to include Pagination, Filtering, Workflows, and other optional sections

Usage

import { planDocumentation } from '@apivexa/planner';

const plan = planDocumentation(analysis);

console.log(plan.sections.map(s => s.title));
// ['Overview', 'Getting Started', 'Authentication', 'API Reference',
//  'Common Workflows', 'Data Models', 'Error Handling', 'Pagination']

The DocumentationPlan returned here is consumed by @apivexa/generator to produce the Documentation IR.

Full documentation