pg_semantic_cache/mkdocs.yml at main · pgEdge/pg_semantic_cache · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
site_name: pg_semantic_cache
site_description: Semantic query result caching for PostgreSQL using vector embeddings
site_author: pgEdge
site_url: https://docs.pgedge.com/pg_semantic_cache

repo_name: pgEdge/pg_semantic_cache
repo_url: https://github.com/pgEdge/pg_semantic_cache
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2025 - 2026, pgEdge, Inc

theme:
  name: material
  custom_dir: docs/overrides
  favicon: img/favicon.ico

  logo_dark_mode: 'img/logo-dark.png'
  logo_light_mode: 'img/logo-light.png'

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.prune
    - navigation.top
    - toc.follow

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  generator: false

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js

plugins:
  - search
  - macros:
      j2_variable_start_string: "<<"
      j2_variable_end_string: ">>"
      j2_comment_start_string: "<#"
      j2_comment_end_string: "#>"

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Overview: index.md
  - Architecture: architecture.md
  - Use Cases: use_cases.md
  - Quick Start: quick_start.md
  - Installation: installation.md
  - Configuration: configuration.md
  - Deployment: production.md
  - Functions:
      - Overview: functions.md
      - Function Reference: functions/index.md
      - Caching:
          - cache_query: functions/cache_query.md
          - get_cached_result: functions/get_cached_result.md
          - invalidate_cache: functions/invalidate_cache.md
      - Monitoring:
          - cache_stats: functions/cache_stats.md
          - cache_hit_rate: functions/cache_hit_rate.md
      - Eviction:
          - evict_expired: functions/evict_expired.md
          - evict_lru: functions/evict_lru.md
          - evict_lfu: functions/evict_lfu.md
          - auto_evict: functions/auto_evict.md
          - clear_cache: functions/clear_cache.md
      - Configuration:
          - set_vector_dimension: functions/set_vector_dimension.md
          - get_vector_dimension: functions/get_vector_dimension.md
          - set_index_type: functions/set_index_type.md
          - get_index_type: functions/get_index_type.md
          - rebuild_index: functions/rebuild_index.md
      - Cost Tracking:
          - log_cache_access: functions/log_cache_access.md
          - get_cost_savings: functions/get_cost_savings.md
      - Utility:
          - init_schema: functions/init_schema.md
  - Sample Integrations:
      - Overview: integration.md
      - pgEdge RAG: integrations/pgedge-rag.md
  - Monitoring: monitoring.md
  - Logging: logging.md
  - Performance and Benchmarking: performance.md
  - Security: security-audit.md
  - Troubleshooting: troubleshooting.md
  - FAQ: FAQ.md
  - Developers: development.md
  - License: LICENSE.md