platform/mkdocs.yml at main · rranabha/platform · 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
site_name: Ambient Code Platform Documentation
site_description: AI-powered automation platform for intelligent agentic workflows
site_author: Red Hat AI Engineering Team
site_url: https://acp-docs.example.com

repo_name: ambient-code/platform
repo_url: https://github.com/ambient-code/platform
edit_uri: edit/main/docs/

# Exclude files from the documentation build
exclude_docs: |
  README.md

theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  palette:
    - scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.annotate

nav:
  - Home: index.md
  - User Guide:
    - Overview: user-guide/index.md
    - Getting Started: user-guide/getting-started.md
    - Working with Amber: user-guide/working-with-amber.md
    - Amber Quickstart: user-guide/amber-quickstart.md
  - Developer Guide:
    - Observability & Instrumentation: observability-langfuse.md
    - Model Pricing: model-pricing.md
  - Architecture:
    - Overview: architecture/README.md
    - Diagrams:
      - Index: architecture/diagrams/index.md
      - System Overview: architecture/diagrams/system-overview.md
      - Session Lifecycle: architecture/diagrams/session-lifecycle.md
  - Labs:
    - Overview: labs/index.md
    - Lab 1 - Your First Agentic Session: labs/basic/lab-1-first-rfe.md
  - Testing:
    - E2E Testing Guide: testing/e2e-guide.md
  - Reference:
    - Overview: reference/index.md
    - Constitution: reference/constitution.md
    - Glossary: reference/glossary.md
  - Deployment Guides:
    - GitHub App Setup: GITHUB_APP_SETUP.md
    - OpenShift Deployment: OPENSHIFT_DEPLOY.md
    - OpenShift OAuth: OPENSHIFT_OAUTH.md
    - Claude Code Runner: CLAUDE_CODE_RUNNER.md

plugins:
  - search
  - mermaid2

markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - toc:
      permalink: true