Skip to content

CATEGORY_INDEX.md

Latest commit

 

History

History
429 lines (345 loc) · 14.5 KB

CATEGORY_INDEX.md

File metadata and controls

429 lines (345 loc) · 14.5 KB

📑 ThemisDB Documentation - Category Index

Complete categorized reference for all ThemisDB documentation, organized by topic and use case.

🎯 Quick Categories

Category Documents Description
🚀 Getting Started 5 docs Installation, first steps, quick tutorials
💡 Use Cases 4 docs Production-ready application guides
🎓 Tutorials 7 docs Step-by-step learning materials
🏆 Certification 5 docs Professional certification paths
📚 Knowledge Base 6 docs Troubleshooting and optimization
📖 Core Docs 50+ docs Architecture, AQL, APIs, features
🛠️ Operations 20+ docs Deployment, monitoring, maintenance
🔐 Security 15+ docs Authentication, encryption, compliance

🚀 Getting Started

For new users - Get ThemisDB up and running quickly.

Installation & Setup

  • Quick Start Guide ⭐ START HERE - 5-minute setup
    • Docker installation
    • First database operations
    • Basic queries
  • Installation Guide - Detailed installation
    • System requirements
    • Platform-specific instructions
    • Configuration options
  • Docker Deployment Guide - Containerized setup
    • Docker compose examples
    • Volume management
    • Multi-container setups
  • Building from Source - Compile ThemisDB
    • Dependencies
    • Build instructions
    • Platform-specific notes

First Steps

  • Getting Started Tutorial - Your first steps
    • Creating databases
    • Basic CRUD operations
    • Simple queries
    • Index creation
  • Configuration Guide - Initial configuration
    • Server settings
    • Security basics
    • Performance tuning
    • Logging setup

💡 Use Cases (Real-World Applications)

Production-ready guides for building specific types of applications.

E-Commerce Platform 🛒

  • E-Commerce Use Case Guide
    • Product catalog with search
    • Inventory management
    • Order processing
    • Recommendation engine
    • Customer analytics
    • Difficulty: ⭐⭐ Intermediate
    • Time: 2-3 hours

IoT & Sensor Networks 📡

  • IoT Use Case Guide
    • Time-series data ingestion
    • Real-time analytics
    • Anomaly detection
    • Device management
    • Historical analysis
    • Difficulty: ⭐⭐⭐ Advanced
    • Time: 3-4 hours

RAG & LLM Applications 🤖

  • RAG/LLM Use Case Guide
    • Vector embeddings
    • Semantic search
    • Document Q&A
    • Native LLM integration
    • Context retrieval
    • Difficulty: ⭐⭐⭐ Advanced
    • Time: 3-4 hours

SaaS Multi-Tenancy 🏢

  • SaaS Use Case Guide
    • Multi-tenant isolation
    • Row-level security
    • Resource quotas
    • Billing tracking
    • GDPR compliance
    • Difficulty: ⭐⭐⭐ Advanced
    • Time: 3-4 hours

🎓 Tutorials (Hands-on Learning)

Step-by-step guides for mastering ThemisDB features.

Core Operations

  • CRUD Operations Tutorial - Create, Read, Update, Delete

    • Entity management
    • Bulk operations
    • Conditional updates
    • Upserts and merges
    • Time: 30 minutes

  • Batch Operations Guide - Efficient bulk handling

    • Batch inserts
    • Transaction batching
    • Performance optimization
    • Error handling
    • Time: 25 minutes

Data Modeling

  • Schema Design Tutorial - Design optimal schemas
    • Multi-model patterns
    • Normalization strategies
    • Index planning
    • Real-world examples
    • Time: 45 minutes

Best Practices

  • Best Practices Guide - Production patterns
    • Query optimization
    • Security guidelines
    • Performance tuning
    • Error handling
    • Time: 40 minutes

Interactive Learning

  • Interactive Examples - Try it yourself

    • Live code snippets
    • Common patterns
    • Real-world scenarios
    • Runnable examples

  • Video Tutorials - Visual learning

    • Video series index
    • Feature deep-dives
    • Use case walkthroughs
    • Webinar recordings

🏆 Certification Program

Validate your expertise with professional certifications.

Certification Overview

Individual Certifications

Entry Level

  • ThemisDB Fundamentals (TDF)
    • Architecture basics
    • Basic AQL
    • Installation & configuration
    • ACID transactions
    • Duration: 90 minutes
    • Passing Score: 70%
    • Prerequisites: None

Advanced Level

  • Query Expert Certification (TQE)

    • Advanced AQL
    • Graph traversals
    • Vector search optimization
    • Query performance tuning
    • Duration: 120 minutes
    • Passing Score: 75%
    • Prerequisites: TDF

  • Operations Certification (TOC)

    • Production deployment
    • Monitoring & alerting
    • Backup & recovery
    • High availability
    • Duration: 120 minutes
    • Passing Score: 75%
    • Prerequisites: TDF

Expert Level

  • Security Certification (TSC)
    • Authentication & authorization
    • Encryption
    • RBAC implementation
    • Compliance (GDPR, HIPAA, SOC 2)
    • Duration: 150 minutes
    • Passing Score: 80%
    • Prerequisites: TDF + (TQE or TOC)

📚 Knowledge Base (Problem Solving)

Troubleshooting and optimization resources for production systems.

Core Guides

Problem Resolution

  • Troubleshooting Guide

    • Connection problems
    • Performance issues
    • Memory problems
    • Crash scenarios
    • Data corruption
    • Recovery procedures
    • Use When: Issues occur
    • Time: 30-45 minutes

  • Log Analysis Guide

    • Log configuration
    • Understanding log format
    • Common patterns
    • Error interpretation
    • Centralized logging
    • Use When: Debugging issues
    • Time: 35-45 minutes

Optimization

  • Performance Tuning Tips
    • Query optimization
    • Index selection
    • Memory configuration
    • Cache tuning
    • Hardware recommendations
    • Use When: Optimizing performance
    • Time: 45-60 minutes

Operations

  • Migration & Upgrade Guides

    • Version upgrades
    • Data migration
    • Zero-downtime upgrades
    • Rollback procedures
    • Use When: Upgrading versions
    • Time: 40-50 minutes

  • Backup & Recovery

    • Backup strategies
    • Point-in-time recovery
    • Disaster recovery
    • Automation scripts
    • Use When: Data protection needed
    • Time: 45-55 minutes

📖 Core Documentation

In-depth technical documentation for all features.

Architecture

Query Language

APIs

Features

🛠️ Operations & Deployment

Production deployment and maintenance documentation.

Deployment

Monitoring

High Availability

Performance

🔐 Security & Compliance

Security implementation and compliance documentation.

Security Implementation

Encryption

Compliance

🌍 Multi-Language Documentation

Documentation is available in multiple languages:

Language Main Guide Use Cases Tutorials
Deutsch (German) docs/de/ ✅ ✅
English docs/en/ ✅ ✅
Español (Spanish) docs/es/ ⏳ In Progress ⏳ In Progress
Français (French) docs/fr/ ⏳ In Progress ⏳ In Progress
日本語 (Japanese) docs/ja/ ⏳ In Progress ⏳ In Progress

📊 Documentation Statistics

Category Total Docs Completed In Progress
Core Documentation 200+ 95% 5%
Tutorials 7 100% -
Use Cases 4 100% -
Certification 5 100% -
Knowledge Base 6 100% -
API Reference 50+ 90% 10%
Operations 30+ 85% 15%

Total Documentation: 1000+ files
Last Updated: 2026-01-31
Documentation Version: 1.4.x

🔍 Search Tips

Finding Documentation

  1. Use the search bar in the documentation site
  2. Check this category index for organized navigation
  3. Review the Documentation Hub for visual navigation
  4. Browse by role in the Documentation Hub

Common Searches

📝 Contributing to Documentation

Found an error or want to improve the docs?

📞 Need Help?

Documentation Maintained by: ThemisDB Documentation Team
Last Major Update: 2026-01-31
Next Review: 2026-02-28