EnforceCore/mkdocs.yml at main · akios-ai/EnforceCore · 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
129
130
131
132
133
134
135
site_name: EnforceCore
site_description: "The runtime enforcement layer for agentic AI systems"
site_url: https://akios.ai/enforcecore
repo_url: https://github.com/akios-ai/EnforceCore
repo_name: akios-ai/EnforceCore

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            heading_level: 2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: quickstart.md
    - FAQ: faq.md
    - Troubleshooting: troubleshooting.md
  - Architecture:
    - Overview: architecture.md
    - API Design: api-design.md
    - Tech Stack: tech-stack.md
  - API Reference:
    - Overview: api/index.md
    - Core:
      - Enforcer: api/enforcer.md
      - Policy: api/policy.md
      - Types: api/types.md
      - Rules: api/rules.md
      - Hardening: api/hardening.md
      - Config: api/config.md
    - Redactor:
      - Engine: api/redactor.md
      - Patterns: api/patterns.md
      - Secrets: api/secrets.md
      - Unicode: api/unicode.md
    - Auditor:
      - Engine: api/auditor.md
      - Backends: api/backends.md
      - Rotation: api/rotation.md
    - Guard:
      - Engine: api/guard.md
      - Network: api/network.md
      - Rate Limiter: api/ratelimit.md
    - Plugins:
      - Hooks: api/hooks.md
      - Webhooks: api/webhooks.md
    - Telemetry:
      - Instrumentor: api/instrumentor.md
      - Metrics: api/metrics.md
    - Integrations: api/integrations.md
    - Evaluation: api/evaluation.md
  - Guides:
    - Developer Guide: dev-guide.md
    - Contributing: contributing.md
    - Migration: migration.md
    - Evaluation Suite: evaluation.md
    - Benchmarks: benchmarks.md
  - Research:
    - Vision: vision.md
    - Related Work: related-work.md
    - Roadmap: roadmap.md
  - Security:
    - Threat Model: threat-model.md
    - Attack Surface: security/attack-surface.md
  - Formal Verification:
    - Invariants: formal/invariants.md
    - Policy Algebra: formal/policy-algebra.md
  - Compliance:
    - EU AI Act: compliance/eu-ai-act.md
    - GDPR: compliance/gdpr.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/akios-ai/EnforceCore