examples/mkdocs.yml at main · fips-agents/examples · 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
site_name: "Building AI Agents on Red Hat AI"
site_description: "A hands-on tutorial for building, deploying, and extending AI agents on Red Hat AI using the fips-agents toolkit"
site_url: https://fips-agents.github.io/examples/
repo_url: https://github.com/fips-agents/examples
repo_name: fips-agents/examples

theme:
  name: material
  font:
    text: Red Hat Text
    code: Red Hat Mono
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

nav:
  - Tutorial:
    - Overview: index.md
    - "0. Before You Begin": 00-prerequisites.md
    - "1. Scaffold Your Agent": 01-scaffold-agent.md
    - "2. Configure and Deploy": 02-configure-and-deploy.md
    - "3. Build an MCP Server": 03-build-mcp-server.md
    - "4. Wire MCP to Agent": 04-wire-mcp-to-agent.md
    - "5. Gateway and UI": 05-gateway-and-ui.md
    - "6. Code Execution Sandbox": 06-code-sandbox.md
    - "7. Extend with AI": 07-extend-with-ai.md
    - "8. Production Hardening": 08-secrets-and-production.md
    - "9. File Uploads": 09-file-uploads.md
    - "10. Platform Mode and Guardrails": 10-guardrails-and-observability.md
    - "11. Scaling with llm-d": 11-scaling-with-llm-d.md
    - "Where to Go Next": where-next.md
  - Supplementary:
    - "Agent Memory with MemoryHub": supplementary/agent-memory.md
    - "Models as a Service": supplementary/maas-model-serving.md
    - "MCP Gateway": supplementary/mcp-gateway.md
  - Setup Guides:
    - "Choosing a Cluster": guides/cluster-options.md
    - "Install OpenShift AI": guides/install-openshift-ai.md
    - "Serve an LLM": guides/serve-an-llm.md
    - "Install CLI Tools": guides/install-cli-tools.md
    - "Registry Setup": guides/registry-setup.md
    - "Install OGX": guides/install-ogx.md
    - "Configure Safety Shields": guides/configure-shields.md
    - "Observability Backends": guides/observability-backends.md
  - Reference:
    - "agent.yaml": reference/agent-yaml.md
    - "Helm Chart": reference/helm-chart.md
    - "Makefile Targets": reference/makefile.md
    - "BaseAgent API": reference/baseagent-api.md
    - "MCP Protocol": reference/mcp-protocol.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fips-agents