zeroshot/mkdocs.yml at main · the-open-engine/zeroshot · 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
156
site_name: Zeroshot
site_description: Zeroshot enforces your team's QA process on coding agents as a graph you define. Versioned docs for the CLI, protocol, and Python SDK.
site_url: https://zeroshot.sh/docs/
repo_url: https://github.com/the-open-engine/zeroshot
repo_name: the-open-engine/zeroshot
copyright: Copyright &copy; The Open Engine

docs_dir: docs
site_dir: site
strict: true
exclude_docs: |
  brand/README.md
  requirements.lock
  requirements.txt
  overrides/

theme:
  name: material
  custom_dir: docs/overrides
  logo: brand/oec-crow.png
  favicon: brand/oec-favicon.svg
  font: false
  features:
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Use dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Use light mode

nav:
  - Overview: index.md
  - Get started:
      - Install: getting-started/install.md
      - Run a first task: getting-started/first-run.md
  - Concepts:
      - How execution works: concepts/execution.md
      - Runtimes and connections: concepts/runtimes-and-connections.md
      - Targets: concepts/targets.md
  - Guides:
      - Plan work before running it: guides/planning.md
      - Prepare a runtime environment: guides/runtime-environments.md
      - Active Memory: guides/active-memory.md
      - Build a review loop: guides/review-loop.md
      - Review an issue or PR: guides/review.md
      - GitHub and GitLab delivery: guides/forge-delivery.md
      - Observe and control runs: guides/observe-and-control.md
      - Use a local graph as an ACP agent: guides/acp.md
      - Python SDK: guides/python-sdk.md
  - Reference:
      - CLI: zeroshot-cli.md
      - Python API:
          - API overview: reference/python.md
          - Client and run handle: reference/python/client.md
          - Configuration: reference/python/configuration.md
          - Result models: reference/python/results.md
          - Exceptions: reference/python/errors.md
      - Cluster protocol:
          - API: reference/cluster/api.md
          - Graph contract: reference/cluster/graph.md
          - RuntimePlan: reference/runtime-plan.md
          - Admission: reference/cluster/admission.md
          - Lifecycle: reference/cluster/lifecycle.md
          - Watch and replay: reference/cluster/watch.md
          - WebSocket data plane: reference/cluster/data-plane.md
          - Portable bindings: reference/cluster/portable-bindings.md
  - Project:
      - Documentation versions: project/versioning.md
      - Distribution contract: zeroshot-distribution.md
      - Source-code adapters: project/source-code-adapters.md
      - Harness adapters: project/harness-adapters.md
  - Zeroshot Platform: https://app.zeroshot.sh/docs
  - zeroshot.sh: https://zeroshot.sh/?utm_source=github&utm_medium=docs&utm_campaign=zeroshot

plugins:
  - search
  - mike:
      alias_type: redirect
  - mkdocstrings:
      handlers:
        python:
          paths: [sdks/python/src]
          options:
            docstring_section_style: list
            docstring_style: google
            heading_level: 2
            members_order: source
            merge_init_into_class: true
            show_root_heading: false
            show_source: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true

hooks:
  - scripts/docs_hook.py

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: [docs]
      check_paths: true
      restrict_base_path: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - toc:
      permalink: true

extra_css:
  - assets/fonts/fonts.css
  - stylesheets/extra.css

extra:
  version:
    provider: mike
    default: current
    alias: false
  social:
    - icon: fontawesome/solid/globe
      link: https://zeroshot.sh/?utm_source=github&utm_medium=docs&utm_campaign=zeroshot
      name: zeroshot.sh
    - icon: fontawesome/brands/github
      link: https://github.com/the-open-engine/zeroshot
    - icon: fontawesome/brands/discord
      link: https://theopenengine.com/discord
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/the-open-engine-company
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/OpenEngineCo