openagent-eval/mkdocs.yml at main · OpenAgentHQ/openagent-eval · 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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# =============================================================================
# OpenAgent Eval — MkDocs Material configuration
# =============================================================================
# Local preview : pip install mkdocs-material && mkdocs serve
# Deploy        : git push origin main  -> automated via GitHub Actions
# =============================================================================

site_name: OpenAgent Eval
site_description: Open-source AI Agent Evaluation Framework
site_url: https://openagenthq.github.io/openagent-eval/
site_author: OpenAgent Eval Contributors
copyright: Copyright &copy; 2024 OpenAgent Eval Contributors &mdash; Apache 2.0 License

# -----------------------------------------------------------------------------
# Repository integration
# -----------------------------------------------------------------------------
repo_name: OpenAgentHQ/openagent-eval
repo_url: https://github.com/OpenAgentHQ/openagent-eval
edit_uri: edit/main/docs/

# -----------------------------------------------------------------------------
# Theme
# -----------------------------------------------------------------------------
theme:
  name: material
  language: en
  favicon: assets/favicon.svg
  logo: assets/logo.svg
  custom_dir: docs/overrides
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    # Light mode — off-white paper, near-black ink
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Dark mode (primary experience) — near-black, off-white ink
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs                  # top-level navigation tabs
    - navigation.tabs.sticky           # keep tabs visible on scroll
    - navigation.sections              # group nav items into sections
    - navigation.top                   # "back to top" button
    - navigation.instant               # instant (SPA-like) navigation
    - navigation.instant.prefetch      # prefetch linked pages
    - navigation.instant.progress      # progress bar on navigation
    - navigation.tracking              # highlight current location
    - navigation.indexes               # section index pages
    - toc.follow                       # TOC follows scroll position
    - toc.integrate                    # merge TOC into nav on mobile
    - content.code.copy                # copy button on code blocks
    - content.code.annotate            # code annotations (+)
    - content.code.select              # click to select code blocks
    - content.tooltips                 # tooltips on cross-references
    - search.suggest                   # search suggestions
    - search.highlight                 # highlight search matches
    - search.share                     # shareable search links
    - announce.dismiss                 # dismissible announcement bar

# -----------------------------------------------------------------------------
# Plugins
# -----------------------------------------------------------------------------
plugins:
  - search:
      lang: en
  - social:
      enabled: false
  - tags:
      enabled: true

# -----------------------------------------------------------------------------
# Markdown extensions
# -----------------------------------------------------------------------------
markdown_extensions:
  # Admonitions / callouts
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # Highlighting & code
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # Formatting
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
      toc_depth: 3

# -----------------------------------------------------------------------------
# Extra assets / metadata
# -----------------------------------------------------------------------------
extra:
  version: 0.1.0
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/OpenAgentHQ/openagent-eval
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/openagenthq
    - icon: fontawesome/brands/discord
      link: https://discord.gg/openagenthq
  analytics:
    provider: false

extra_css:
  - stylesheets/extra.css

# -----------------------------------------------------------------------------
# Navigation
# -----------------------------------------------------------------------------
nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quickstart: quickstart.md
  - Providers:
      - providers/index.md
      - LLM:
          - providers/llm/index.md
          - API Key Setup: providers/llm/api-key-setup.md
          - OpenAI: providers/llm/openai.md
          - Anthropic: providers/llm/anthropic.md
          - Gemini: providers/llm/gemini.md
          - Groq: providers/llm/groq.md
          - OpenRouter: providers/llm/openrouter.md
          - Ollama: providers/llm/ollama.md
          - Mock: providers/llm/mock.md
      - Retrievers:
          - providers/retrievers/index.md
          - Chroma: providers/retrievers/chroma.md
          - Qdrant: providers/retrievers/qdrant.md
          - Pinecone: providers/retrievers/pinecone.md
          - Weaviate: providers/retrievers/weaviate.md
          - FAISS: providers/retrievers/faiss.md
          - PGVector: providers/retrievers/pgvector.md
          - Elasticsearch: providers/retrievers/elasticsearch.md
          - BM25: providers/retrievers/bm25.md
          - Memory: providers/retrievers/memory.md
          - HTTP: providers/retrievers/http.md
          - Mock: providers/retrievers/mock.md
      - Embedders:
          - providers/embedders/index.md
          - Sentence Transformers: providers/embedders/sentence_transformers.md
          - Mock: providers/embedders/mock.md
  - Guide:
      - Architecture: architecture.md
      - CLI Reference: cli.md
      - Configuration Reference: config-reference.md
      - Plugin Development: plugin-development.md
      - Environment Variables: environment-variables.md
      - API Reference: api.md
      - Report Output Formats: reports-output-formats.md
  - Examples:
      - examples/index.md
      - Colab Quickstart: examples/colab.md
      - RAG Evaluation: examples/rag.md
      - Corpus Health Auditor: examples/corpus.md
  - Community:
      - Contributing: contributing.md
      - Roadmap: roadmap.md
      - FAQ: faq.md