RVM.DocForge
Generates automatic documentation from C# repositories using Roslyn, with 7 output formats and historical snapshots.
Overview
RVM.DocForge is an API service that automatically analyzes C# repositories and generates comprehensive documentation. It uses Roslyn for static code analysis, extracts API endpoints, domain entities and services, then generates multiple documentation formats: README, API Reference, Entity Schema, Architecture Overview, Dependency Graph, Service Catalog and Full Documentation. The system persists analysis snapshots and generated documents in PostgreSQL for historical tracking.
Features
- Automated repository analysis using Roslyn (syntax tree parsing)
- Documentation generation in 7 formats: README, API Reference, Entity Schema, Architecture Overview, Dependency Graph, Service Catalog, Full Documentation
- Snapshot tracking with analysis history
- API endpoint extraction with routes, HTTP methods and parameters
- Entity discovery (classes, records, structs, enums) with properties
- Service catalog with method signatures and DI lifetime
- Markdown generation with Markdig
- API Key authentication with role-based rate limiting
Technologies
Patterns & architecture
REST endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/projects | List projects |
| POST | /api/projects | Create project |
| POST | /api/analysis/{projectId} | Analyze repository |
| GET | /api/analysis/snapshots/{id} | Snapshot details |
| POST | /api/documents/generate | Generate documentation |
| GET | /api/documents/{id}/raw | Raw Markdown |