coldfront/mkdocs.yml at main · pgEdge/coldfront · 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
site_name: ColdFront

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - meta
  - pymdownx.details
  - pymdownx.superfences

plugins:
  - search

validation:
  links:
    anchors: warn

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

copyright: Copyright &copy; 2026 pgEdge, Inc
repo_url: https://github.com/pgEdge/ColdFront

nav:
  - Getting Started:
      - Introduction: index.md
      - Walkthrough: walkthrough.md
      - Installation: installation.md
      - Object Store Setup: object_store.md

  - Architecture:
      - Overview: architecture.md
      - Tiered Mode: architecture_tiered.md
      - Decoupled Mode: architecture_decoupled.md
      - Vector Storage: architecture_vectors.md

  - Using ColdFront: usage.md
  - Embeddings: usage_vectors.md
  - Compaction: compaction.md

  - Developer Resources:
      - Formal Verification: formal/README.md

  - Changelog: changelog.md
  - License: LICENSE.md