codecrucible-synth/dist/core/documentation-sync-system.d.ts

Production-Ready AI Development Platform with Multi-Voice Synthesis, Smithery MCP Integration, Enterprise Security, and Zero-Timeout Reliability

#!/usr/bin/env node
/**
 * Documentation Synchronization System
 * Automatically syncs and validates documentation across the codebase
 */
interface DocumentationIssue {
    type: 'outdated' | 'missing' | 'broken_link' | 'inconsistent' | 'duplicate';
    severity: 'low' | 'medium' | 'high' | 'critical';
    file: string;
    description: string;
    suggestion: string;
    autoFixable: boolean;
}
interface DocumentationMetrics {
    totalFiles: number;
    outdatedFiles: number;
    missingDocumentation: number;
    brokenLinks: number;
    coverageScore: number;
    lastUpdated: number;
}
export declare class DocumentationSyncSystem {
    private docs;
    private issues;
    private codeFiles;
    /**
     * Analyze and synchronize all documentation
     */
    syncDocumentation(): Promise<{
        metrics: DocumentationMetrics;
        issues: DocumentationIssue[];
        recommendations: string[];
    }>;
    /**
     * Discover all relevant files
     */
    private discoverFiles;
    /**
     * Classify documentation type
     */
    private classifyDocType;
    /**
     * Extract references (links, code references, etc.)
     */
    private extractReferences;
    /**
     * Analyze documentation for issues
     */
    private analyzeDocumentation;
    /**
     * Check for missing documentation
     */
    private checkMissingDocumentation;
    /**
     * Check if file has inline documentation
     */
    private hasInlineDocumentation;
    /**
     * Check if file has external documentation
     */
    private hasExternalDocumentation;
    /**
     * Validate references and links
     */
    private validateReferences;
    /**
     * Check for outdated content
     */
    private checkOutdatedContent;
    /**
     * Check code examples in documentation
     */
    private checkCodeExamples;
    /**
     * Generate missing documentation
     */
    private generateMissingDocs;
    /**
     * Generate a documentation file
     */
    private generateDocFile;
    /**
     * Generate README content
     */
    private generateReadme;
    /**
     * Generate API documentation
     */
    private generateApiDocs;
    /**
     * Extract exports from code files
     */
    private extractExports;
    /**
     * Generate setup guide
     */
    private generateSetupGuide;
    /**
     * Generate changelog
     */
    private generateChangelog;
    /**
     * Calculate documentation metrics
     */
    private calculateMetrics;
    /**
     * Generate recommendations
     */
    private generateRecommendations;
    /**
     * Generate comprehensive report
     */
    generateReport(): string;
    /**
     * Apply automatic fixes
     */
    applyAutomaticFixes(): Promise<{
        fixed: number;
        failed: number;
    }>;
    /**
     * Fix version references in documentation
     */
    private fixVersionReferences;
    /**
     * Dispose of the documentation sync system
     */
    dispose(): void;
}
export {};
//# sourceMappingURL=documentation-sync-system.d.ts.map