chromasql/mkdocs.yml at main · GetAdriAI/chromasql · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
site_name: ChromaSQL Documentation
site_description: SQL-like DSL for querying ChromaDB collections.
repo_url: https://github.com/GetAdriAI/chromasql
repo_name: GetAdriAI/chromasql
nav:
  - Overview: index.md
  - Using ChromaSQL:
    - Tutorial:
      - Setup: using-chromasql/tutorial/setup.md
      - Basics: using-chromasql/tutorial/basics.md
      - Filtering: using-chromasql/tutorial/filtering.md
      - Vector Search: using-chromasql/tutorial/vector-search.md
      - Reranking and Batching: using-chromasql/tutorial/reranking-batching.md
      - Filter-Only Retrieval: using-chromasql/tutorial/filter-only.md
      - Explain: using-chromasql/tutorial/explain.md
      - Limitations: using-chromasql/tutorial/limitations.md
      - Troubleshooting: using-chromasql/tutorial/troubleshooting.md
    - Quick Reference: using-chromasql/quick-reference.md
  - Using ChromaSQL Python Package:
    - Overview: using-csql-py/index.md
    - Getting Started: using-csql-py/getting-started.md
    - Examples: using-csql-py/examples.md
    - Multi-Collection:
      - Overview: using-csql-py/multi-collection/overview.md
      - Examples: using-csql-py/multi-collection/EXAMPLES.md
      - Edge Cases: using-csql-py/multi-collection/OR_ROUTING_EDGE_CASES.md
  - Using ChromaSQL with LLMs: using-csql-llm/chromasql-prompt.md
  - Building Extensions: building-extensions.md
  - Reference:
    - Grammar Reference: reference/language-grammar.md
    - Multi-Collection Architecture: reference/multi-collection-architecture.md
    - Multi-Collection Routing Strategies: reference/routing-strategies.md
    - Glossary: reference/glossary.md

plugins:
  - search
  - macros:
      module_name: docs/main

theme:
  name: material
  custom_dir: overrides
  features:
    - navigation.tabs        # Adds top navigation bar
    - navigation.indexes  # This enables bold section headers
    - navigation.footer
    - content.code.copy # enables the copy button in code block
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
markdown_extensions:
  - attr_list
  - admonition
  - codehilite
  - toc:
      permalink: true
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
extra_css:
  - assets/css/custom.css
copyright: |
  Powered by <a href="https://research.getadri.ai/" target="_blank">
    <img src="chromasql/docs/assets/adri-ai-full-logo.png" alt="Logo">
    Adri AI
  </a>