AgentVault/mkdocs.yml at main · ruFFaa/AgentVault · 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
# MkDocs Configuration for AgentVault

site_name: AgentVault Documentation
site_url: https://SecureAgentTools.github.io/AgentVault/
repo_url: https://github.com/SecureAgentTools/AgentVault/
repo_name: AgentVault
edit_uri: "" # Disable edit button for now

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - mermaid
  palette:
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  # logo: assets/logo.png # Add logo later if desired

plugins:
  - search # Enable search plugin

# --- MODIFIED: Added Vision and Use Cases (placeholder) to Nav ---
nav:
  - Home: index.md
  - Vision: vision.md # Added Vision page prominently
  - Introduction:
    - Concepts: concepts.md
    - Architecture: architecture.md
    - Use Cases: use_cases.md # Added Use Cases page link
  - Installation: installation.md
  - Examples:
      - Overview: examples.md
      - Basic A2A Server: examples/basic_a2a_server.md
      - LangChain Tool: examples/langchain_integration.md
      - OAuth Agent: examples/oauth_agent_example.md
      - Stateful Agent: examples/stateful_agent_example.md
      - Direct Library Usage: examples/library_usage_example.md
  - User Guide:
    - CLI Usage: user_guide/cli.md
  - Developer Guide:
    - Client Library (`agentvault`): developer_guide/library.md
    - Server SDK (`agentvault-server-sdk`): developer_guide/server_sdk.md
    - Registry API (`agentvault_registry`): developer_guide/registry.md
    - Testing Utilities (`agentvault-testing-utils`): developer_guide/testing.md
  - Protocols:
    - A2A Profile v0.2: a2a_profile_v0.2.md
    - TEE Profile: tee_profile.md
  - Project & Policies:
    - Contributing: CONTRIBUTING.md
    - Code of Conduct: CODE_OF_CONDUCT.md
    - Security: security.md
    - Security Policy: security_policy.md
    - Registry Policy: REGISTRY_POLICY.md
    - Terms of Service: TERMS_OF_SERVICE.md
    - Privacy Policy: privacy_policy.md
    - Roadmap: ROADMAP.md
# --- END MODIFIED ---

# Source directory for markdown files
docs_dir: 'docs'

# Optional: Add markdown extensions for enhanced formatting
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
  - admonition
  - toc:
      permalink: true
      toc_depth: 3 # Adjust depth as needed
  - attr_list # Allows adding classes/ids to markdown elements
  - md_in_html # Allows markdown processing inside HTML blocks

# Copyright notice (optional)
# copyright: Copyright &copy; 2025 AgentVault Contributors