agentflow4j/mkdocs.yml at main · datallmhub/agentflow4j · 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
site_name: AgentFlow4J
site_description: Build multi-agent AI workflows in Java. Run them in production with security, governance, resilience, and FinOps — built into every execution, JVM-native, Spring-powered.
site_url: https://datallmhub.github.io/agentflow4j/
site_author: agentflow4j

repo_url: https://github.com/datallmhub/agentflow4j
repo_name: datallmhub/agentflow4j
edit_uri: edit/main/docs/

docs_dir: docs

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/header-home-link.js

theme:
  name: material
  language: en
  features:
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  logo: images/agentflow4j.png
  favicon: images/agentflow4j.png
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Core concepts: concepts.md
  - Get started:
      - Getting started: getting-started.md
      - Two API levels: two-api-levels.md
      - LLM providers: llm-providers.md
      - Typed state: state.md
  - Governance:
      - Tool policy: tool-policy.md
      - State policy: state-policy.md
      - Approval gate: approval-gate.md
  - Resilience & runtime:
      - Resilience & error handling: resilience.md
      - Run log: run-log.md
      - Observability: observability.md
      - Streaming: streaming.md
  - Recipes:
      - Approval via Slack: recipes/approval-via-slack.md
      - Durable runs: recipes/durable-runs.md
  - Tutorials:
      - "Run your first agent for free (Mistral)": tutorials/free-mistral-quickstart.md
      - "Stop your agent burning $1000 overnight": tutorials/stop-your-agent-burning-money.md
      - "Multi-agent workflow in Java with Spring AI": tutorials/multi-agent-workflow-java-spring-ai.md
      - "Human-in-the-loop approval in Java AI agents": tutorials/human-in-the-loop-java-ai-agents.md
      - "LLM cost control for Java agents — BudgetPolicy": tutorials/llm-cost-control-java-budget-policy.md
      - "Checkpoint and resume agent workflows in Spring Boot": tutorials/checkpoint-resume-agent-spring-boot.md
  - Testing: testing.md
  - Samples: samples.md
  - Cookbook ↗: https://github.com/datallmhub/agentflow4j-cookbook

plugins:
  - search
  - social:
      enabled: !ENV [SOCIAL_CARDS, true]   # set SOCIAL_CARDS=false for local preview without Cairo
      cards: true
      cards_layout_options:
        background_color: "#0f172a"  # slate-900
        color: "#e2e8f0"             # slate-200

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/datallmhub/agentflow4j