OpenAgentLock/mkdocs.yml at main · openagentlock/OpenAgentLock · 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
116
117
118
119
120
121
122
123
124
125
126
127
128
site_name: OpenAgentLock
site_url: https://openagentlock.github.io/OpenAgentLock/
site_description: A locally-hosted, open-source firewall for AI coding agents.
site_author: OpenAgentLock contributors
copyright: Copyright &copy; 2026 OpenAgentLock contributors — FSL-1.1-Apache-2.0

repo_url: https://github.com/openagentlock/OpenAgentLock
repo_name: openagentlock/OpenAgentLock
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  language: en
  logo: assets/logo-mark.svg
  favicon: assets/favicon.svg
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.action.view
  palette:
    - media: "(prefers-color-scheme)"
      toggle: { icon: material/brightness-auto, name: Switch to light mode }
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: black
      toggle: { icon: material/brightness-7, name: Switch to dark mode }
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: white
      toggle: { icon: material/brightness-4, name: Switch to system preference }
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/openagentlock/OpenAgentLock
  status:
    shipped: Shipped
    not-yet: Not yet implemented
    roadmap: Roadmap

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

nav:
  - Home: index.md
  - Guide:
      - Getting started: guide/getting-started.md
      - Installation: guide/installation.md
      - Policies and rules: guide/policies.md
      - Signers: guide/signers.md
      - The ledger: guide/ledger.md
      - Dashboard: guide/dashboard.md
      - Isolation: guide/isolation.md
      - MCP: guide/mcp.md
      - Threat model: guide/threat-model.md
      - Authentication: guide/auth.md
      - Windows notes: guide/windows.md
  - Architecture:
      - Overview: architecture/overview.md
      - LLM-based guardrails (roadmap): architecture/llm-guardrails.md
      - False positive reporting (design): architecture/false-positive-reporting.md
  - Reference:
      - HTTP API: reference/api.md
      - Detection registry: reference/detection.md
      - Hooks: reference/hooks.md
      - Hook → daemon path: reference/hook-daemon-path.md
  - FAQ: faq.md
  - Status: status.md