-
Notifications
You must be signed in to change notification settings - Fork 2
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Overview
Implement a change watching system that monitors code changes and proactively triggers documentation drift detection. This enables real-time awareness of when documentation may become stale.
Background
This enhancement supports ADR-009: Documentation Synchronization Agent from the DocuMCP Orchestrator project. The change watcher enables proactive drift detection rather than relying solely on manual checks.
Requirements
Core Functionality
- Monitor git hooks for code changes
- Support webhook integration for CI/CD pipelines
- File system watching for development environments
- Debounced change detection to avoid excessive processing
Trigger Events
- Post-commit hooks
- Pull request events
- Branch merge events
- Manual trigger API
Change Analysis
- Identify which functions/classes changed
- Map changes to affected documentation sections
- Calculate change impact scores
- Queue drift detection jobs
Configuration Options
interface ChangeWatcherConfig {
watchPaths: string[];
excludePatterns: string[];
debounceMs: number;
triggerOnCommit: boolean;
triggerOnPR: boolean;
webhookEndpoint?: string;
}Acceptance Criteria
- Git hook integration works with standard git workflows
- Webhook endpoint accepts GitHub/GitLab events
- Changes are correctly mapped to documentation sections
- Debouncing prevents duplicate processing
- Configuration is flexible for different project setups
Dependencies
- Requires: Existing drift detection in
drift-detector.ts - Optional: Issue feat: Add LLM integration layer for semantic code analysis #71 (LLM Integration Layer) for semantic change analysis
Implementation Notes
- Consider using
chokidarfor file system watching - Git hooks should be installable via CLI command
- Webhook should validate request signatures
Related
- ADR-009: Documentation Synchronization Agent
src/utils/drift-detector.ts- existing drift detection
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request