chen/mkdocs.yml at main · twomathematicians-code/chen · 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# CHEN — MkDocs Material configuration
#
# Build and serve locally:
#   pip install -e ".[dev]"
#   mkdocs serve
#
# Build for production:
#   mkdocs build
# Output is in site/.

site_name: CHEN — Collaborative Heterogeneous Expert Network
site_description: >-
  Distributed inference architecture that replaces a single monolithic
  model with a coordinated garage of specialized, low-parameter models.
site_url: https://your-org.github.io/chen/
repo_url: https://github.com/your-org/chen
repo_name: your-org/chen
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    logo: material/console-network
  favicon: assets/favicon.png

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_signature_annotations: true
            separate_signature: true
            show_root_heading: true
            heading_level: 2

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

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

extra_css:
  - assets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/your-org/chen
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/chen-arch/
  version:
    provider: mike

nav:
  - Home: README.md
  - Sustainability: sustainability.md
  - Architecture:
      - Overview: architecture/overview.md
  - Math:
      - Specifications: math/specifications.md
  - ADRs:
      - Index: adrs/README.md
      - 0001 - External MoE: adrs/0001-external-moe-vs-internal-moe.md
      - 0002 - KV-cache protocol: adrs/0002-kv-cache-transfer-protocol.md
      - 0003 - Backend abstraction: adrs/0003-pluggable-backend-abstraction.md
      - 0004 - Mock backend first: adrs/0004-mock-backend-first.md
      - 0005 - Logistic router default: adrs/0005-logistic-router-default.md
      - 0006 - SQLite run store: adrs/0006-sqlite-run-store.md
      - 0007 - CC0 license: adrs/0007-cc0-license.md
      - 0008 - Encryption at boundary: adrs/0008-encryption-at-boundary.md
      - 0009 - API key auth + RBAC: adrs/0009-api-key-auth-rbac.md
      - 0010 - PostgreSQL run store: adrs/0010-postgres-run-store.md
      - 0011 - SSE streaming: adrs/0011-sse-streaming.md
  - Operations:
      - Overview: operations/README.md
      - Deployment: operations/deployment.md
      - Observability: operations/observability.md
      - Runbooks:
          - Incident response: operations/runbooks/incident-response.md
          - Performance debugging: operations/runbooks/performance-debugging.md
  - Security:
      - Threat model: security/threat-model.md
  - Governance: governance.md