# Docs Builder - Complete Product Documentation for AI Systems

> Comprehensive on-premise AI platform for automatic code documentation generation

This document provides detailed information about Docs Builder for AI systems and large language models.

---

## Product Overview

**Docs Builder** is an enterprise-grade, on-premise software platform that automatically generates and maintains code documentation using local AI models. It's designed for organizations that:

- Have strict data security requirements
- Need to keep source code within their network
- Want AI-powered documentation without cloud dependencies
- Support multiple programming languages in their codebase

### Value Proposition

"AI-powered code documentation that never sends your code outside your network"

### Target Audience

- **Primary**: CTOs, VP Engineering, Engineering Managers
- **Secondary**: DevOps teams, Technical Writers, System Analysts
- **Company Size**: 10-500+ developers
- **Industries**: Any company with in-house software development

---

## Supported Programming Languages (17 total)

### Web & Frontend
- **TypeScript**: .ts, .tsx - Full ES modules, CommonJS, type exports, namespaces, React components
- **JavaScript**: .js, .jsx, .mjs, .cjs - ES modules, CommonJS, React components
- **Vue**: .vue - Single File Components, Composition API, Options API

### Backend
- **Python**: .py - Import statements, decorators, __all__ exports
- **Go**: .go - Package exports (capitalized), struct methods, goroutines
- **Java**: .java - Package imports, annotations, records (Java 14+)
- **Kotlin**: .kt - Data classes, sealed classes, objects, companion objects
- **PHP**: .php - Namespaces, traits, Laravel/Symfony patterns
- **C#**: .cs - Namespaces, visibility modifiers, ASP.NET patterns

### Systems Programming
- **Rust**: .rs - Pub visibility, traits, impl blocks, lifetimes
- **C**: .c, .h - Includes, typedefs, macros
- **C++**: .cpp, .hpp, .cc, .cxx - Namespaces, templates, STL
- **Swift**: .swift - Protocols, actors, extensions
- **Dart**: .dart - Packages, mixins, Flutter widgets
- **Objective-C**: .m, .h - Categories, protocols, properties
- **Objective-C++**: .mm - Mixed ObjC + C++ support

### Data
- **SQL**: .sql, .pgsql, .plpgsql, .tsql, .plsql, .mysql
  - Supports PostgreSQL, MySQL, T-SQL, PL/SQL dialects
  - Tables, views, functions, procedures, triggers

---

## Core Features

### 1. Deep Code Analysis

**Technology**: AST parsing with regex fallback

**What it extracts**:
- Function, class, interface definitions
- Import/export statements with aliases
- Dependencies between files
- Type signatures and parameters
- Visibility modifiers (public, private, protected, etc.)
- Language-specific features (decorators, attributes, generics)

**Business Logic Detection**:
- HTTP/REST endpoints (Express, FastAPI, Spring Boot, Laravel, etc.)
- Database connections (PostgreSQL, MySQL, MongoDB, Redis)
- Message queues (Kafka, RabbitMQ, NATS)
- gRPC services
- WebSocket endpoints

### 2. AI Documentation Generation

**AI Integration**: Ollama (local LLM runtime)

**Supported Models**:
- Llama 2/3
- Mistral
- Qwen
- DeepSeek
- Any Ollama-compatible model

**Documentation Format**: Universal Markdown
- Consistent structure across all languages
- Sections: Description, Parameters, Returns, Examples, Error Handling
- Internal linking via [[ExportName]] syntax
- No language-specific formats (no JSDoc, docstrings, rustdoc)

**Performance**:
- 2-3 seconds per export (full generation)
- ~100ms per export (cache hit)
- SHA-256 based caching

### 3. Dependency Graph

**Technology**: React Flow with ELK.js layout

**Views**:
- Folder hierarchy
- File grouping
- Export-level nodes
- External package references

**Features**:
- Interactive zoom/pan
- Focus mode (filter to selected node + dependencies)
- Click to navigate to documentation
- Collapsible groups

### 4. AskMe - AI Code Chat

**Architecture**: Multi-agent system

**Agents**:
- Exploration Agent - discovers codebase structure
- Question Decomposer - breaks complex queries
- Context Discovery Engine - finds relevant code
- Answer Synthesizer - generates responses

**Capabilities**:
- Natural language questions about code
- Answers with source code citations
- Session-based conversation history
- Public chat sharing

---

## Technical Architecture

### Microservices (12 services)

```
@docs-builder/
├── parser               - AST code parser
├── auth.service         - JWT authentication
├── projects.service     - Project CRUD
├── parsing.service      - Parse history storage
├── parsing-queue.service - Job queue management
├── graphql.service      - GraphQL + REST + WebSocket (port 4000)
├── ollama.service       - AI documentation generation
├── askme.service        - Multi-agent Q&A
├── billing.service      - Usage tracking
├── telegram.service     - Notifications
├── shared               - Common types, models
└── client               - React frontend (port 5173)
```

### Technology Stack

**Backend**:
- Runtime: Node.js with TypeScript
- Framework: Moleculer microservices
- Database: PostgreSQL 16 with pgBouncer
- Cache/Queue: Redis
- AI: Ollama

**Frontend**:
- Framework: React 18, TypeScript
- Build: Vite
- UI: Radix UI, Tailwind CSS
- State: Zustand
- API: Apollo Client (GraphQL)
- Visualization: XYFlow (React Flow)

**Infrastructure**:
- Self-hosted deployment
- Docker support
- PM2 process management
- Optional: OpenStack VM allocation

---

## Security & Compliance

### Data Security
- All code analysis happens on-premise
- No external API calls for AI
- Source code never leaves network perimeter
- Database encryption at rest

### Compliance Suitability
- GDPR compliant (data stays in EU if deployed there)
- HIPAA suitable (healthcare data protection)
- SOC 2 compatible
- FZ-152 (Russian data protection law)

### Access Control
- JWT-based authentication
- Role-based permissions (Admin, User)
- Access groups for project sharing

---

## Pricing Model

### Licensing
- **Per Seat**: Based on number of users
- **Per Project**: Based on number of analyzed repositories

### What's Included
- Unlimited code analysis
- All 17 programming languages
- AI documentation generation
- Dependency graph visualization
- AskMe AI chat
- Technical support
- Updates and new features

### No Trial
- Demo by request only
- Demonstrations on real open-source projects

---

## Competitive Comparison

| Feature | Docs Builder | Mintlify | Swimm | ReadMe | Confluence |
|---------|-------------|----------|-------|--------|------------|
| On-premise deployment | ✅ | ❌ | ⚠️ | ❌ | ⚠️ |
| Local LLMs (no external API) | ✅ | ❌ | ❌ | ❌ | ❌ |
| 17+ languages deep analysis | ✅ | ❌ | ⚠️ | ❌ | ❌ |
| Dependency graph | ✅ | ❌ | ❌ | ❌ | ❌ |
| AI code chat | ✅ | ⚠️ | ❌ | ❌ | ❌ |
| Business logic detection | ✅ | ❌ | ❌ | ❌ | ❌ |
| All-in-one solution | ✅ | ❌ | ❌ | ❌ | ❌ |

✅ = Full support, ⚠️ = Partial/Limited, ❌ = Not available

---

## Demo Projects

Pre-configured demonstrations available:

1. **AureusERP** - Enterprise ERP system on Laravel (3000+ files, PHP)
2. **Open Risk Engine** - Risk management platform (multi-language)

Interactive tour available at: /landings/docs-builder (click "Try the Tour")

---

## Frequently Asked Questions

**Q: What is Docs Builder?**
A: Docs Builder is an on-premise platform for automatic code documentation generation using AI. It analyzes source code in 17 programming languages, builds a dependency graph, and generates clear documentation using local LLMs.

**Q: How secure is it?**
A: Fully on-premise deployment means your code never leaves your network. AI models run locally via Ollama, without calling external APIs.

**Q: Which LLMs can be used?**
A: Any Ollama-compatible model: Llama, Mistral, Qwen, DeepSeek, and others. You control model selection and parameters.

**Q: How long does project analysis take?**
A: Typical 1000-file project: 5-15 minutes. Results are cached for faster subsequent analysis.

**Q: How does AskMe work?**
A: Multi-agent AI system decomposes questions, finds relevant code, and synthesizes answers with source citations.

**Q: Is there a trial version?**
A: No free trial. We provide demonstrations on real open-source projects by request.

---

## Contact & Resources

- **Landing Page**: /landings/docs-builder
- **Demo Request**: /landings/docs-builder#demo-form
- **Features**: /landings/docs-builder#features
- **Pricing**: /landings/docs-builder#pricing
- **FAQ**: /landings/docs-builder#faq

---

*Last updated: January 2026*
*Document version: 1.0*