seal/mkdocs.yml at master · rezearcher/seal · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: Seal / VPE
site_description: Verified Prompt Envelope Protocol — Cryptographic provenance for AI agent prompts
site_url: https://rezearcher.github.io/seal
repo_url: https://github.com/rezearcher/seal
repo_name: rezearcher/seal
edit_uri: edit/main/docs/

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

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [seal]
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            show_if_no_docstring: false
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rezearcher/seal

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Protocol Specification: spec.md
  - API Reference:
      - Overview: api/index.md
      - seal.core: api/core.md
      - seal.vpe: api/vpe.md
      - seal.audit: api/audit.md
      - seal.broker: api/broker.md
      - seal.credential_store: api/credential_store.md
      - seal.store: api/store.md
      - seal.key_store: api/key_store.md
      - seal.key_manager: api/key_manager.md
      - seal.rollback: api/rollback.md
      - seal.epd: api/epd.md
      - seal.integration: api/integration.md
  - CLI Reference: cli.md
  - Integration Guide: integration.md
  - Threat Model: threat-model.md
  - Architecture: architecture.md
  - License: license.md