Skip to content

DocumentPlan

reference
1 min readUpdated

Kind: Interface

Source: atloria-monorepo/packages/doc-automation/src/v2/types/stage-09.types.ts

Properties

PropertyType
documentIdstring
titlestring
sectionsSectionPlan[]
frontmatter`{
description: string;
keywords: string[];
difficulty: 'beginner' | 'intermediate' | 'advanced';
estimatedReadTime: number; // minutes

}| |requiredEntities|{ primary: string[]; // Entity IDs that MUST be included fully secondary: string[]; // Entity IDs for context (can be summarized) crossChunk: string[]; // Entity IDs from OTHER chunks (need fetching) }| |criticalCode|Array<{ entityId: string; reason: 'validation' | 'state_machine' | 'error_messages' | 'permissions'; minCharacters: number; // Minimum chars to include (default: 2000) }>| |sourceChunkId|string| |relatedChunkIds|string[]` |

Was this page helpful?

Download as PDF