relay-shell/mkdocs.yml at main · rmednitzer/relay-shell · 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
# MkDocs Material configuration for the relay-shell documentation site.
#
# Built from docs/ and published to GitHub Pages by .github/workflows/docs.yml.
# One-time repo setting required:
#   Settings -> Pages -> Build and deployment -> Source: "GitHub Actions"
# (this replaces the former Jekyll "Deploy from a branch" source).
# Local preview:  pip install -r requirements-docs.txt && mkdocs serve
site_name: relay-shell
site_description: >-
  A governed Model Context Protocol relay for complete shell and SSH operation:
  central audit, tiered authority, secret redaction, and resource bounds.
site_url: https://rmednitzer.github.io/relay-shell/
site_author: Roman Mednitzer
repo_url: https://github.com/rmednitzer/relay-shell
repo_name: rmednitzer/relay-shell
edit_uri: edit/main/docs/
copyright: Apache-2.0 licensed.
docs_dir: docs

# docs/_config.yml is the legacy Jekyll config, retained only so the old
# "Deploy from a branch" build keeps serving during the switch to GitHub
# Actions. It is not part of this site.
exclude_docs: |
  _config.yml

theme:
  name: material
  palette:
    # Dark by default (per the site's design), with a one-click light toggle.
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.action.edit

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

nav:
  - Overview: index.md
  - Guides:
      - Architecture: architecture.md
      - Tool reference: tools.md
      - Deployment: deployment.md
      - Authentication: auth.md
      - Audit shipping: audit-shipper.md
      - Maintenance runbook: runbook.md
  - Decision records:
      - Overview: adr/README.md
      - 0001 · Runtime, SDK & SSH library: adr/0001-runtime-and-sdk.md
      - 0002 · Unsandboxed full-access posture: adr/0002-no-sandbox-full-access.md
      - 0003 · Tiered authority: adr/0003-tiered-authority.md
      - 0004 · Automated TLS at the edge: adr/0004-edge-tls-automation.md
      - 0005 · Codebase validation: adr/0005-codebase-validation.md
      - 0006 · seccomp-bpf audit channel: adr/0006-seccomp-notify-audit-channel.md
      - 0007 · Tamper-evident audit hash chain: adr/0007-audit-hash-chain.md
      - 0008 · Operating-guidance prompt: adr/0008-operating-guidance-prompt.md
      - 0009 · Tier-3 confirmation broker: adr/0009-tier3-confirmation-broker.md
      - 0010 · Rollback / verify broker (proposed): adr/0010-rollback-verify-broker.md
      - 0011 · Windows OpenSSH + PowerShell 7: adr/0011-windows-openssh-powershell.md