doctool
Version:
AI-powered documentation validation and management system
31 lines (30 loc) • 978 B
TypeScript
export interface DocumentationIssue {
type: 'missing_files' | 'outdated_descriptions' | 'missing_sections' | 'placeholder_content' | 'inconsistent_structure';
severity: 'low' | 'medium' | 'high';
description: string;
location?: {
section?: string;
line?: number;
};
suggestedFix: {
action: 'add_section' | 'update_content' | 'add_files' | 'remove_placeholder';
content?: string;
target?: string;
};
}
export interface DocumentationAnalysis {
filePath: string;
issues: DocumentationIssue[];
overallHealth: 'good' | 'needs_attention' | 'poor';
lastUpdated?: Date;
filesAnalyzed: string[];
directoryChanges: {
newFiles: string[];
modifiedFiles: string[];
deletedFiles: string[];
};
}
/**
* Analyzes a knowledge file for specific issues
*/
export declare function analyzeDocumentationIssues(knowledgeFilePath: string, basePath: string): DocumentationAnalysis;