aiwg
Version:
Deployment tool and support utility for AI context. Copies agents, skills, commands, rules, and behaviors into the paths each AI platform reads (Claude Code, Codex, Copilot, Cursor, Warp, OpenClaw, and 6 more) so one source of truth works across 10 platfo
65 lines • 1.79 kB
TypeScript
/**
* Documentation service for generating structured paper summaries
*
* @module research/services/documentation
*/
import { ResearchPaper } from '../types.js';
import { PaperSummary, Claim, GRADEAssessment, AcquiredSource } from './types.js';
/**
* Configuration for documentation service
*/
export interface DocumentationConfig {
/** Template directory for notes */
templateDir?: string;
/** Output directory for generated notes */
outputDir?: string;
}
/**
* Documentation service for generating summaries and notes
*/
export declare class DocumentationService {
constructor(_config?: DocumentationConfig);
/**
* Generate structured summary from paper
* Note: Full implementation would use LLM or PDF parsing
*/
summarize(_paperPath: string): Promise<PaperSummary>;
/**
* Extract claims from paper
* Note: Full implementation would use NLP/LLM
*/
extractClaims(_paperPath: string): Promise<Claim[]>;
/**
* Generate Zettelkasten literature note
*/
generateNote(paper: ResearchPaper, summary: PaperSummary): Promise<string>;
/**
* Assess GRADE quality level
*/
assessGRADE(source: AcquiredSource): Promise<GRADEAssessment>;
/**
* Determine starting GRADE quality based on publication type
*/
private determineStartingQuality;
/**
* Downgrade GRADE level
*/
private downgradeLevel;
/**
* Upgrade GRADE level
*/
private upgradeLevel;
/**
* Build GRADE justification text
*/
private buildJustification;
/**
* Generate citation in APA format
*/
private generateCitation;
/**
* Format authors in APA style
*/
private formatAuthorsAPA;
}
//# sourceMappingURL=documentation.d.ts.map