mkdocs.yml

site_name: shardyfusion
site_description: Sharded SlateDB/SQLite snapshot writer/reader library
site_url: https://elkin.github.io/shardyfusion/
repo_url: https://github.com/elkin/shardyfusion
repo_name: elkin/shardyfusion

theme:
  name: material
  icon:
    logo: material/layers
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - content.code.copy

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - .
          options:
            show_source: false

nav:
  - Home: index.md
  - Use cases:
    - Overview: use-cases/index.md
    - Extras matrix: use-cases/extras-matrix.md
    - Shared snapshot workflow: use-cases/shared-snapshot-workflow.md
    - Sharded KV storage:
      - Overview: use-cases/kv-storage/overview.md
      - Build:
        - Choosing a writer: use-cases/kv-storage/build/index.md
        - Python: use-cases/kv-storage/build/python.md
        - Spark: use-cases/kv-storage/build/spark.md
        - Dask: use-cases/kv-storage/build/dask.md
        - Ray: use-cases/kv-storage/build/ray.md
      - Read:
        - Choosing a reader: use-cases/kv-storage/read/index.md
        - Sync SlateDB: use-cases/kv-storage/read/sync/slatedb.md
        - Sync SQLite: use-cases/kv-storage/read/sync/sqlite.md
        - Async SlateDB: use-cases/kv-storage/read/async/slatedb.md
        - Async SQLite: use-cases/kv-storage/read/async/sqlite.md
    - Sharded KV + Vector:
      - Overview: use-cases/kv-vector/overview.md
      - Build:
        - Composite (SlateDB + LanceDB): use-cases/kv-vector/build/composite.md
        - Unified (sqlite-vec): use-cases/kv-vector/build/unified.md
      - Read:
        - Sync: use-cases/kv-vector/read/sync.md
        - Async: use-cases/kv-vector/read/async.md
    - Sharded Vector search:
      - Overview: use-cases/vector/overview.md
      - Build:
        - LanceDB: use-cases/vector/build/lancedb.md
        - sqlite-vec: use-cases/vector/build/sqlite-vec.md
        - Spark: use-cases/vector/build/spark.md
        - Dask: use-cases/vector/build/dask.md
        - Ray: use-cases/vector/build/ray.md
      - Read:
        - Sync: use-cases/vector/read/sync.md
        - Async: use-cases/vector/read/async.md
  - Operations:
    - Overview: operate/index.md
    - Runtime:
      - CLI: operate/cli.md
      - History & rollback: operate/history-rollback.md
    - Metrics:
      - Prometheus metrics: operate/prometheus-metrics.md
      - OTel metrics: operate/otel-metrics.md
    - Production:
      - Production guide: operate/production.md
      - Cloud testing: operate/cloud-testing.md
      - Tox & dependency matrix: operate/tox-matrix.md
  - Architecture:
    - Overview: architecture/index.md
    - Writer core: architecture/writer-core.md
    - Sharding: architecture/sharding.md
    - Routing: architecture/routing.md
    - Manifest & _CURRENT: architecture/manifest-and-current.md
    - Manifest stores: architecture/manifest-stores.md
    - Run registry: architecture/run-registry.md
    - Retry & cleanup: architecture/retry-and-cleanup.md
    - Adapters: architecture/adapters.md
    - Observability: architecture/observability.md
    - Error model: architecture/error-model.md
    - Optional imports: architecture/optional-imports.md
    - SQLite page-cache sidecar: architecture/sqlite-sidecar.md
  - Reference:
    - Public API: reference/api.md
    - Configuration: reference/config.md
    - CLI: reference/cli.md
    - SQLite Page-Cache Sidecar Format: reference/sqlite-sidecar-format.md
    - Glossary: reference/glossary.md
  - Contributing:
    - Overview: contributing/index.md
    - Local development: contributing/local-development.md
    - Testing: contributing/testing.md
    - Extras & dependencies: contributing/extras-and-dependencies.md
    - Adding an adapter: contributing/adding-an-adapter.md
    - Adding a writer: contributing/adding-a-writer.md
    - Adding a use case: contributing/adding-a-use-case.md
    - Documentation policy: contributing/documentation-policy.md
  - History:
    - Overview: history/index.md
    - Reorganization notes: history/reorg-notes.md
    - Design decisions:
      - Overview: history/design-decisions/index.md
      - ADR-001 Two-phase publish: history/design-decisions/adr-001-two-phase-publish.md
      - ADR-002 Categorical CEL routing: history/design-decisions/adr-002-categorical-cel-routing.md
      - ADR-003 Run registry for deferred cleanup: history/design-decisions/adr-003-run-registry-deferred-cleanup.md
      - ADR-004 Consistent writer retry: history/design-decisions/adr-004-consistent-writer-retry.md
      - ADR-005 Sharded vector search: history/design-decisions/adr-005-sharded-vector-search.md
      - ADR-006 LanceDB vector backend: history/design-decisions/adr-006-lancedb-vector-backend.md
    - Implementation plans:
      - Overview: history/implementation-plans/index.md
      - Reliable loser cleanup: history/implementation-plans/2026-03-15-reliable-loser-cleanup-plan.md
      - Test coverage gap closure: history/implementation-plans/2026-03-24-test-coverage-gap-closure.md
    - Historical notes:
      - Overview: history/historical-notes/index.md
      - 2026-03-14 Manifest history & rollback: history/historical-notes/2026-03-14-manifest-history-and-rollback.md
      - 2026-03-15 Reliable loser cleanup plan: history/historical-notes/2026-03-15-reliable-loser-cleanup-plan.md
      - 2026-03-24 Test coverage gap closure: history/historical-notes/2026-03-24-test-coverage-gap-closure.md
      - 2026-03-25 Consistent writer retry: history/historical-notes/2026-03-25-consistent-writer-retry.md
      - 2026-03-25 Run registry for deferred cleanup: history/historical-notes/2026-03-25-run-registry-for-deferred-cleanup.md
      - 2026-03-28 Categorical CEL routing: history/historical-notes/2026-03-28-categorical-cel-routing.md
      - 2026-04-04 Sharded vector search: history/historical-notes/2026-04-04-sharded-vector-search.md
      - 2026-04-06 Vector search review: history/historical-notes/2026-04-06-vector-search-review.md
      - 2026-04-19 LanceDB vector migration: history/historical-notes/2026-04-19-lancedb-vector-migration.md
      - 2026-05-04 slatedb 0.12 uniffi migration: history/historical-notes/2026-05-04-slatedb-0.12-uniffi-migration.md

markdown_extensions:
  - admonition
  - codehilite
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true