SwitchBoard/mkdocs.yml at main · ProtocolWarden/SwitchBoard · 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
site_name: SwitchBoard
site_description: Policy-driven execution-lane selector for canonical task proposals
site_url: https://protocolwarden.github.io/SwitchBoard/
repo_url: https://github.com/ProtocolWarden/SwitchBoard
repo_name: ProtocolWarden/SwitchBoard
edit_uri: edit/main/docs/

theme:
  name: material
  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.instant
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy

nav:
  - Home: README.md
  - Get Started:
    - Quickstart: quickstart.md
    - Configuration: reference/configuration.md
  - Routing:
    - Routing: routing/routing.md
    - Routing Examples: routing/routing-examples.md
    - Request Flow: routing/request-flow.md
    - Lanes: routing/lanes.md
    - Policies: routing/policies.md
  - Reference:
    - API: reference/api.md
  - Operate:
    - Observability: operate/observability.md
    - Troubleshooting: operate/troubleshooting.md
    - Stability: operate/stability.md
  - System:
    - Architecture: system/architecture.md
    - Roadmap: system/roadmap.md

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