DOCUMENTATION_INDEX.md

ThemisDB Documentation Index

📝 Translation Notice
The authoritative documentation is in German. This is a community translation.
See German docs for the most current version.

Last Updated: April 2026
Version: 1.3.0 (LLM Integration Release)
Language: English

🎯 Quick Start by Role

For Developers

1. README.md - Project Overview & Quick Start
2. Build Strategy - Build Toolchain (Windows/Linux/Docker)
3. Build Guide - Detailed Build Instructions
4. Development Summary - Current Development Status
5. Enterprise Features - Enterprise Scalability Features

For Stakeholders

1. Themis Status Report 2025 - Executive Summary
2. THEMIS_PROJECT_VALUATION.md - 🔒 Confidential (available to licensed customers only)
3. Feature Overview - Feature Overview with Status
4. Roadmap - Development Roadmap

For Compliance & Audits

1. Compliance Dashboard - Executive Compliance Summary
2. Compliance Checklist - BSI C5, ISO 27001, GDPR, eIDAS, SOC 2
3. Security Audit Report - Security Audit Results
4. Security Policy - Vulnerability Disclosure Policy
5. License Compatibility - ⭐ License Compatibility (v1.3.0)
6. Third-Party Licenses - ⭐ Third-Party License Attribution (v1.3.0)

📚 Documentation Structure

Root-Level Documents

/
├── README.md                        # Project Overview & Quick Start
├── LICENSE                          # MIT License with Government Clause
├── THIRD_PARTY_LICENSES.md          # ⭐ Third-Party License Attribution (v1.3.0)
├── aql/                             # ⭐ AQL EBNF Grammar (v1.3.0)
│   ├── AQL_GRAMMAR.ebnf             # Complete formal grammar
│   └── README.md                    # AQL Overview
├── features/features_overview.md    # Feature List with Status
├── ROADMAP.md                       # Development Roadmap
├── CHANGELOG.md                     # Change History
├── guides/guides_build_strategy.md  # Build Toolchain & Strategy
├── INTEGRATION_ANALYSIS.md          # Enterprise Integration Analysis
├── TEST_REPORT.md                   # Complete Test Report
├── DEVELOPMENT_AUDITLOG.md          # Development Status & Audit
├── DOCKER_DEPLOYMENT.md             # Docker Deployment Guide (v1.3.0)
└── CONTRIBUTING.md                  # Contribution Guidelines

docs/ - Structured Documentation

docs/
├── enterprise/                      # Enterprise Features
│   └── README.md                    # Enterprise Overview & Guide
├── performance/                     # Performance & Benchmarks
│   └── ENTERPRISE_SCALABILITY_STRATEGY.md
├── security/                        # Security & Compliance
├── legal/                           # ⭐ Legal & Licensing (v1.3.0)
│   └── LICENSE_COMPATIBILITY_ANALYSIS.md  # Dependency License Analysis
├── architecture/                    # Architecture Documentation
├── api/                            # API Documentation
└── guides/                         # User Guides

🚀 Enterprise Features

Documentation

Document	Purpose	Target Audience
enterprise/README.md	Overview & Quick Start	Developers, DevOps
enterprise/enterprise_scalability.md	Feature Details & Code Examples	Developers
enterprise/enterprise_http_pool.md	HTTP Client Implementation	Developers
enterprise/enterprise_final_report.md	Implementation Summary	Stakeholders
INTEGRATION_ANALYSIS.md	Legacy Integration	Developers

Status

• ✅ Token Bucket Rate Limiter - Production Ready (5/5 Tests)
• ✅ Per-Client Rate Limiter - Production Ready (3/3 Tests)
• ✅ Load Shedder - Production Ready (5/5 Tests)
• ✅ HTTP Client Pool - Production Ready (6/6 Tests)
• ✅ Batch Operations - Production Ready (1/1 Tests)

Test Coverage: 20/20 (100%)

📖 Architecture & Design

Core Architecture

• architecture.md - System Architecture Overview
• storage/storage_rocksdb.md - RocksDB Storage Layout
• mvcc_design.md - MVCC Transaction Design
• query_engine_aql.md - Query Engine & AQL

Special Features

• geo/GEO_ARCHITECTURE.md - Geo/Spatial Architecture
• vector_ops.md - Vector Operations & HNSW
• content_pipeline.md - Content Processing Pipeline
• search/hybrid_search_design.md - Hybrid Search

🔒 Security & Compliance

Security

• security/security_overview.md - Security Overview
• encryption_strategy.md - Encryption Strategy
• security/security_key_management.md - Key Management
• security/security_threat_model.md - Threat Model
• security_hardening_guide.md - Hardening Guide

Compliance

• compliance/compliance_dashboard.md - Executive Dashboard
• compliance/compliance_dpia.md - Data Protection Impact Assessment (GDPR)
• compliance/compliance_bcp_drp.md - Business Continuity & Disaster Recovery
• compliance_audit.md - Compliance Audit
• AUDIT_LOGGING.md - Audit Logging

PKI & eIDAS

• pki_integration_architecture.md - PKI Integration
• eidas_qualified_signatures.md - eIDAS Signatures
• security/pki_rsa_integration.md - PKI RSA Integration

🛠️ Build & Deployment

Build Documentation

• guides/guides_build_strategy.md - Build Strategy & Platforms
• guides/guides_build.md - Detailed Build Instructions

Deployment

• deployment.md - Deployment Strategies
• DOCKER_MULTI_ARCH_STRATEGY.md - Multi-Arch Docker
• docs/CI_CD_MULTIARCH.md - Multi-Arch CI/CD

Platform-Specific

• ARM_RASPBERRY_PI_BUILD.md - Raspberry Pi Build
• ARM_BENCHMARKS.md - ARM Performance
• RASPBERRY_PI_TUNING.md - Pi Tuning Guide

📊 Performance & Benchmarks

• performance_benchmarks.md - Performance Overview
• compression_benchmarks.md - Compression
• encryption_metrics.md - Encryption Performance
• performance/ENTERPRISE_SCALABILITY_STRATEGY.md - Enterprise Strategy

🔍 API & Query Language

AQL (Advanced Query Language)

• aql_syntax.md - AQL Syntax
• aql-hybrid-queries.md - Hybrid Queries
• aql_explain_profile.md - EXPLAIN & PROFILE
• recursive_path_queries.md - Recursive Paths
• temporal_graphs.md - Temporal Graphs

APIs

• apis/openapi.md - REST API & OpenAPI Spec
• apis/contentfs_api.md - ContentFS API
• apis/hybrid_search_api.md - Hybrid Search API

👥 Client SDKs

• clients/javascript_sdk_quickstart.md - JavaScript SDK
• clients/python_sdk_quickstart.md - Python SDK
• clients/rust_sdk_quickstart.md - Rust SDK

📝 Development

Guidelines

• development/developers.md - Developer Guide
• code_quality.md - Code Quality Pipeline
• CONTRIBUTING.md - Contribution Guidelines

Status & Planning

• DEVELOPMENT_AUDITLOG.md - Development Audit
• development/implementation_status.md - Status
• development/ROADMAP.md - Roadmap
• development/priorities.md - Priorities

API Implementations

• development/audit_api_implementation.md - Audit API
• development/saga_api_implementation.md - SAGA API

🔗 External Resources

GitHub

• Repository: https://github.com/makr-code/ThemisDB
• Wiki: https://github.com/makr-code/ThemisDB/wiki
• Issues: https://github.com/makr-code/ThemisDB/issues

Badges

• 
• 
• 

📋 Navigation by Topic

Source Modules (16 Components)

Module	README	Sources	Headers	LOC
analytics	docs/analytics/README.md	2	3	3,742
cache	docs/cache/README.md	1	6	492
cdc	docs/cdc/README.md	1	1	510
content	docs/content/README.md	15	16	9,091
geo	docs/geo/README.md	3	2	304
governance	docs/governance/README.md	1	1	259
index	docs/index/README.md	11	12	14,629
llm	docs/llm/README.md	2	2	679
query	docs/query/README.md	12	12	12,560
replication	docs/replication/README.md	1	2	1,612
security	docs/security/README.md	16	16	8,138
server	docs/server/README.md	20	20	18,282
sharding	docs/sharding/README.md	19	21	12,278
storage	docs/storage/README.md	10	9	4,591
timeseries	docs/timeseries/README.md	8	7	2,767
transaction	docs/transaction/README.md	2	2	895

Total: 124 source files, 132 header files, 90,829 LOC

Audit Report: SOURCE_CODE_AUDIT.md

Multi-Model Features

• Graph: property_graph_model.md, graph_index.cpp.md
• Geo/Spatial: GEO_ARCHITECTURE.md, geo_acceleration_3d_games.md
• Time-Series: time_series.md, timeseries/continuous_agg.cpp.md
• Document: content_pipeline.md, content/content_manager.cpp.md
• Vector/Embedding: vector_ops.md, gnn_embeddings.md

Storage & Persistence

• RocksDB: storage/storage_rocksdb.md, storage/rocksdb_wrapper.cpp.md
• MVCC: mvcc_design.md
• Transactions: transactions.md, transaction/saga.cpp.md
• Compression: compression_strategy.md, timeseries/gorilla.cpp.md

Search & Indexing

• Fulltext: search/fulltext_api.md, search/stemming.md
• Hybrid Search: search/hybrid_search_design.md
• Vector Search: vector_ops.md, index/vector_index.cpp.md
• Geo Indexing: geo/cpu_backend.cpp.md

Governance & PII

• PII Detection: security/pii_detection.md, pii_api.md
• Policies: security/security_policies.md, governance/policy_engine.cpp.md
• RBAC: rbac_authorization.md, RBAC.md
• Retention: security/audit_and_retention.md

⚠️ Deprecated / Archive

Outdated or superseded documentation:

• archive/ - Archived documents
• merge_reports/ - Git merge reports

🔄 Synchronization

Wiki Sync

./sync-wiki.ps1

Local Preview

./build-docs.ps1  # MkDocs → site/

GitHub Pages

• Primary: GitHub Wiki (authoritative)
• Secondary: MkDocs Build (for development)

📞 Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Security: See SECURITY.md

---

Documentation Status: ✅ Consolidated (December 5, 2025)
Maintainer: ThemisDB Team
Last Audit: December 5, 2025