Skip to content

DOCUMENTATION_INDEX

makr-code edited this page Dec 22, 2025 · 2 revisions

ThemisDB Dokumentations-Index

Letzte Aktualisierung: 20. Dezember 2025 Version: 1.3.0 (LLM Integration Release)

🎯 Schnelleinstieg nach Rolle

Für Entwickler

  1. README.md - Projektübersicht & Quick Start
  2. guides/guides_build_strategy.md - Build-Toolchain (Windows/Linux/Docker)
  3. docs/guides/guides_build.md - Detaillierte Build-Anleitung
  4. DEVELOPMENT_AUDITLOG.md - Aktueller Entwicklungsstand
  5. Enterprise Features - Enterprise Scalability Features

Für Stakeholder

  1. THEMIS_SACHSTANDSBERICHT_2025.md - Executive Summary
  2. THEMIS_PROJECT_VALUATION.md - 🔒 Confidential (available to licensed customers only)
  3. features/features_overview.md - Feature-Übersicht mit Status
  4. ROADMAP.md - Entwicklungs-Roadmap

Für Compliance & Audits

  1. compliance/compliance_dashboard.md - Executive Compliance Summary
  2. compliance/compliance_full_checklist.md - BSI C5, ISO 27001, DSGVO, eIDAS, SOC 2
  3. security/SECURITY_AUDIT_REPORT.md - Security Audit Ergebnisse
  4. SECURITY.md - Vulnerability Disclosure Policy
  5. legal/LICENSE_COMPATIBILITY_ANALYSIS.md - ⭐ License Compatibility (v1.3.0)
  6. THIRD_PARTY_LICENSES.md - ⭐ Third-Party License Attribution (v1.3.0)

📚 Dokumentationsstruktur

Root-Level Dokumente

/
├── README.md                        # Projektübersicht & Quick Start
├── LICENSE                          # MIT License with Government Clause
├── THIRD_PARTY_LICENSES.md          # ⭐ Third-Party License Attribution (v1.3.0)
├── aql/                             # ⭐ AQL EBNF Grammatik (v1.3.0)
│   ├── AQL_GRAMMAR.ebnf             # Vollständige formale Grammatik
│   └── README.md                    # AQL Übersicht
├── features/features_overview.md    # Feature-Liste mit Status
├── ROADMAP.md                       # Entwicklungs-Roadmap
├── CHANGELOG.md                     # Änderungshistorie
├── guides/guides_build_strategy.md  # Build-Toolchain & Strategie
├── INTEGRATION_ANALYSIS.md          # Enterprise Integration Analysis
├── TEST_REPORT.md                   # Vollständiger Test-Report
├── DEVELOPMENT_AUDITLOG.md          # Entwicklungsstand & Audit
├── DOCKER_DEPLOYMENT.md             # Docker Deployment Guide (v1.3.0)
└── CONTRIBUTING.md                  # Contribution Guidelines

docs/ - Strukturierte Dokumentation

docs/
├── enterprise/                      # Enterprise Features
│   └── README.md                    # Enterprise Übersicht & Guide
├── performance/                     # Performance & Benchmarks
│   └── ENTERPRISE_SCALABILITY_STRATEGY.md
├── security/                        # Sicherheit & Compliance
├── legal/                           # ⭐ Legal & Licensing (v1.3.0)
│   └── LICENSE_COMPATIBILITY_ANALYSIS.md  # Dependency License Analysis
├── architecture/                    # Architektur-Dokumentation
├── api/                            # API-Dokumentation
└── guides/                         # User Guides

🚀 Enterprise Features

Dokumentation

Dokument Zweck Zielgruppe
enterprise/README.md Übersicht & Quick Start Entwickler, DevOps
enterprise/enterprise_scalability.md Feature-Details & Code-Beispiele Entwickler
enterprise/enterprise_http_pool.md HTTP Client Implementation Entwickler
enterprise/enterprise_final_report.md Implementation Summary Stakeholder
INTEGRATION_ANALYSIS.md Legacy Integration Entwickler

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%)

📖 Architektur & Design

Kern-Architektur

Spezielle Features

🔒 Security & Compliance

Security

Compliance

PKI & eIDAS

🛠️ Build & Deployment

Build-Dokumentation

Deployment

Platform-Specific

📊 Performance & Benchmarks

🔍 API & Query Language

AQL (Advanced Query Language)

APIs

👥 Client SDKs

📝 Development

Guidelines

Status & Planning

API Implementations

🔗 External Resources

GitHub

Badges

  • CI
  • Code Quality
  • ARM Build

📋 Navigation nach Thema

Source-Module (16 Komponenten)

Modul README Source 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

Gesamt: 124 Source-Dateien, 132 Header-Dateien, 90,829 LOC

Audit-Report: SOURCE_CODE_AUDIT.md

Multi-Model Features

Storage & Persistence

Search & Indexing

Governance & PII

⚠️ Deprecated / Archive

Veraltete oder abgelöste Dokumentation:

🔄 Synchronisation

Wiki Sync

./sync-wiki.ps1

Lokale Vorschau

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

GitHub Pages

  • Primär: GitHub Wiki (maßgeblich)
  • Sekundär: MkDocs Build (für Entwicklung)

📞 Support


Dokumentations-Status: ✅ Konsolidiert (5. Dezember 2025)
Maintainer: ThemisDB Team
Letzte Audit: 5. Dezember 2025

ThemisDB Dokumentation

Version: 1.3.0 | Stand: Dezember 2025


📋 Schnellstart


🏗️ Architektur


🗄️ Basismodell


💾 Storage & MVCC


📇 Indexe & Statistiken


🔍 Query & AQL


💰 Caching


📦 Content Pipeline


🔎 Suche


⚡ Performance & Benchmarks


🏢 Enterprise Features


✅ Qualitätssicherung


🧮 Vektor & GNN


🌍 Geo Features


🛡️ Sicherheit & Governance

Authentication

Schlüsselverwaltung

Verschlüsselung

TLS & Certificates

PKI & Signatures

PII Detection

Vault & HSM

Audit & Compliance

Security Audits

Gap Analysis


🚀 Deployment & Betrieb

Docker

Observability

Change Data Capture

Operations


💻 Entwicklung

API Implementations

Changefeed

Security Development

Development Overviews


📄 Publikation & Ablage


🔧 Admin-Tools


🔌 APIs


📚 Client SDKs


📊 Implementierungs-Zusammenfassungen


📅 Planung & Reports


📖 Dokumentation


📝 Release Notes


📖 Styleguide & Glossar


🗺️ Roadmap & Changelog


💾 Source Code Documentation

Main Programs

Source Code Module


🗄️ Archive


🤝 Community & Support


Vollständige Dokumentation: https://makr-code.github.io/ThemisDB/

Clone this wiki locally