apflow/mkdocs.yml at main · aipartnerup/apflow · 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
157
158
159
160
161
162
163
164
site_name: apflow Documentation
site_description: Task Orchestration and Execution Framework Documentation
site_url: https://aipartnerup.github.io/apflow/
repo_url: https://github.com/aipartnerup/apflow
repo_name: aipartnerup/apflow
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2025 aipartnerup

# Theme
theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy
    - content.code.select
  icon:
    repo: fontawesome/brands/github

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started/index.md
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
    - Core Concepts: getting-started/concepts.md
    - Examples: getting-started/examples.md
    - Tutorials:
      - First Steps: getting-started/tutorials/tutorial-01-first-steps.md
      - Task Trees: getting-started/tutorials/tutorial-02-task-trees.md
      - Dependencies: getting-started/tutorials/tutorial-03-dependencies.md
  - Guides:
    - Task Orchestration: guides/task-orchestration.md
    - Executor Selection: guides/executor-selection.md
    - Custom Tasks: guides/custom-tasks.md
    - Best Practices: guides/best-practices.md
    - CLI: guides/cli.md
    - API Server: guides/api-server.md
    - Distributed Cluster: guides/distributed-cluster.md
    - Library Usage: guides/library-usage.md
    - Scheduler: guides/scheduler.md
    - Extensions: guides/extensions.md
    - Environment Variables: guides/environment-variables.md
    - FAQ: guides/faq.md
  - CLI:
    - Overview: cli/index.md
    - Commands: cli/commands.md
    - Configuration: cli/configuration.md
    - Examples: cli/examples.md
    - API Gateway: cli/api-gateway.md
  - API Reference:
    - Python API: api/python.md
    - HTTP API: api/http.md
    - GraphQL API: api/graphql.md
    - Quick Reference: api/quick-reference.md
  - Examples:
    - Basic Tasks: examples/basic_task.md
    - Task Trees: examples/task-tree.md
    - Real World: examples/real-world.md
    - Email Executor: examples/email-executor.md
    - Generate Executor: examples/generate-executor.md
  - Architecture:
    - Overview: architecture/overview.md
    - Diagrams: architecture/diagrams.md
    - Directory Structure: architecture/directory-structure.md
    - Extension Registry: architecture/extension-registry-design.md
    - Task Manager: architecture/task-manager.md
    - Exception Handling: architecture/exception-handling.md
    - Configuration: architecture/configuration.md
    - Task Tree Lifecycle: architecture/task-tree-lifecycle.md
  - Protocol:
    - Overview: protocol/index.md
    - Introduction: protocol/01-overview.md
    - Core Concepts: protocol/02-core-concepts.md
    - Data Model: protocol/03-data-model.md
    - Execution Lifecycle: protocol/04-execution-lifecycle.md
    - Examples: protocol/05-examples.md
    - Interfaces: protocol/06-interfaces.md
    - Conformance: protocol/07-conformance.md
    - Errors: protocol/08-errors.md
    - Validation: protocol/09-validation.md
  - Development:
    - Setup: development/setup.md
    - Contributing: development/contributing.md
    - Roadmap: development/roadmap.md
    - Design:
      - CLI Design: development/design/cli-design.md
      - Aggregate Results: development/design/aggregate-results-design.md

# Plugins
plugins:
  - search
  - mermaid2:
      arguments:
        theme: base
        themeVariables:
          primaryColor: '#6366f1'
          primaryTextColor: '#fff'
          primaryBorderColor: '#6366f1'
          lineColor: '#F8B229'
          secondaryColor: '#006100'
          tertiaryColor: '#fff'
  - minify:
      minify_html: true

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - 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.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aipartnerup/apflow
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/apflow/