mkdocs.yml

site_name: DecentDB Documentation
site_description: DecentDB - Embedded relational database engine with ACID guarantees
site_author: DecentDB Contributors
site_url: https://decentdb.org

docs_dir: docs
exclude_docs: |
  README.md

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - First Steps: getting-started/first-steps.md
  - User Guide:
    - SQL Reference: user-guide/sql-reference.md
    - SQL Feature Matrix: user-guide/sql-feature-matrix.md
    - Data Types: user-guide/data-types.md
    - Interactive SQL Shell: user-guide/repl.md
    - Branching, Diff, Restore, And Time Travel: user-guide/branching.md
    - Migrations: user-guide/migration.md
    - Transactions: user-guide/transactions.md
    - Write Concurrency: user-guide/write-concurrency.md
    - Local Data Security: user-guide/security.md
    - Lua Extensions: user-guide/lua-extensions.md
    - Local-first sync:
      - Overview: user-guide/sync/index.md
      - Quickstart: user-guide/sync/quickstart.md
      - Concepts: user-guide/sync/concepts.md
      - Scopes: user-guide/sync/scopes.md
      - Conflicts: user-guide/sync/conflicts.md
      - Schema compatibility: user-guide/sync/schema-compatibility.md
      - Security: user-guide/sync/security.md
      - Operations: user-guide/sync/operations.md
      - Troubleshooting: user-guide/sync/troubleshooting.md
      - Examples: user-guide/sync/examples.md
    - Indexes: user-guide/indexes.md
    - Performance Tuning: user-guide/performance.md
    - Benchmarks: user-guide/benchmarks.md
    - Comparison Overview: user-guide/comparison.md
    - DecentDB vs SQLite: user-guide/decentdb-vs-sqlite.md
    - DecentDB vs libSQL: user-guide/decentdb-vs-libsql.md
    - DecentDB vs Turso Database: user-guide/decentdb-vs-tursodatabase.md
    - DecentDB vs PGlite: user-guide/decentdb-vs-pglite.md
    - DecentDB vs DuckDB: user-guide/decentdb-vs-duckdb.md
    - DecentDB vs H2: user-guide/decentdb-vs-h2.md
    - DecentDB vs Firebird Embedded: user-guide/decentdb-vs-firebird-embedded.md
    - DecentDB vs LiteDB: user-guide/decentdb-vs-litedb.md
    - DecentDB vs RocksDB: user-guide/decentdb-vs-rocksdb.md
    - DecentDB vs LMDB: user-guide/decentdb-vs-lmdb.md
    - DecentDB vs LevelDB: user-guide/decentdb-vs-leveldb.md
    - DecentDB vs sled: user-guide/decentdb-vs-sled.md
    - Tools:
      - Doctor: user-guide/doctor.md
      - DBeaver Integration: user-guide/dbeaver.md
  - API Reference:
    - Rust API: api/rust-api.md
    - SQL Functions: api/sql-functions.md
    - CLI Reference: api/cli-reference.md
    - Binding Compatibility Matrix: api/bindings-matrix.md
    - Error Codes: api/error-codes.md
    - Configuration: api/configuration.md
    - Language Bindings:
      - C/C++ ABI: api/c-cpp.md
      - .NET (C#): api/dotnet.md
      - Dart/Flutter: api/dart.md
      - Go: api/go.md
      - JDBC Driver (Java): api/jdbc.md      
      - Node.js: api/node.md
      - Python: api/python.md
      - WASM / Browser: api/wasm.md
  - Architecture:
    - Overview: architecture/overview.md
    - Storage Engine: architecture/storage.md
    - WAL & Recovery: architecture/wal.md
    - B+Tree: architecture/btree.md
    - Query Execution: architecture/query-execution.md
  - Development:
    - Building from Source: development/building.md
    - Testing: development/testing.md
    - Release process: development/releases.md
    - GitHub Releases: https://github.com/sphildreth/decentdb/releases
    - Import Tools: development/import-tools.md
    - SQLite Import Notes: development/sqlite-import-notes.md
    - Contributing: development/contributing.md
  - Design Documents:
    - PRD: design/prd.md
    - Specification: design/spec.md
    - Road to RTM: design/road-to-rtm.md
    - ADRs: design/adr.md
  - About:
    - License: about/license.md
    - Changelog: about/changelog.md

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - minify:
      minify_html: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/sphildreth/decentdb
  version:
    provider: mike

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

copyright: Copyright © 2026 DecentDB Contributors

extra_css:
  - stylesheets/extra.css