baft/mkdocs.yml at main · IranTransitionProject/baft · 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
site_name: Baft
site_description: ITP analytical engine — application layer on the Heddle framework
site_url: https://irantransitionproject.github.io/baft/
repo_url: https://github.com/IranTransitionProject/baft
repo_name: IranTransitionProject/baft

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github

# Theme-aware diagram switching.  Pages that ship both ``foo.svg`` and
# ``foo-dark.svg`` can embed both with ``#only-light`` / ``#only-dark``
# URL fragments and the CSS rules pick the right one per Material palette.
# See heddle's adoption (heddle v0.9.2 §"Dark-mode diagrams") for the
# pattern; baft's existing diagrams ship only ``-light`` variants today,
# so this file is wired up for the next dark-mode SVG to land without
# requiring further config changes.
extra_css:
  - stylesheets/theme-aware-images.css

plugins:
  - search
  - mkdocstrings:
      enabled: !ENV [MKDOCSTRINGS_ENABLED, true]
      default_handler: python
      enable_inventory: false
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list

nav:
  - Home: index.md
  - User Guide:
    - Setup: SETUP.md
    - Analyst Guide: ANALYST_GUIDE.md
    - Operations Guide: OPERATIONS_GUIDE.md
    - Claude Desktop: CLAUDE_DESKTOP_GUIDE.md
    - Claude Chat Project: CLAUDE_CHAT_PROJECT.md
    - Claude Chat Sessions: CLAUDE_CHAT_SESSION_INSTRUCTIONS.md
    - Claude Code Build: CLAUDE_CODE_BUILD_INSTRUCTIONS.md
    - Design Invariants: DESIGN_INVARIANTS.md
    - Heddle Builders Guide: HEDDLE_BUILDERS_GUIDE.md
  - Deployment:
    - Helm Chart: HELM_DEPLOYMENT.md
    - Track B Spec: TRACK_B_HELM_AND_SESSION_AUTOMATION.md
  - Architecture:
    - Multi-Agent Architecture: architecture/ITP_MULTI_AGENT_ARCHITECTURE_v0_5.md
  - API Reference:
    - Contracts — Core: api/contracts-core.md
    - Contracts — Audit: api/contracts-audit.md
    - Contracts — Monitor: api/contracts-monitor.md
    - Sessions: api/sessions.md
    - Tracing: api/tracing.md
  - References:
    - Robotic LLM: references/ROBOTIC-LLM.md