acpkit/mkdocs.yml at main · vcoderun/acpkit · 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
site_name: ACP Kit
site_description: ACP adapters, remote transport, and host-facing tooling for Pydantic AI and LangChain agents
site_url: https://vcoderun.github.io/acpkit/
strict: true
repo_name: vcoderun/acpkit
repo_url: https://github.com/vcoderun/acpkit
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - content.action.view

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
            - packages/adapters/pydantic-acp/src
            - packages/adapters/langchain-acp/src
            - packages/helpers/codex-auth-helper/src
            - packages/transports/acpremote/src
          options:
            docstring_style: google
            members_order: source
            merge_init_into_class: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true

markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vcoderun/acpkit

extra_css:
  - stylesheets/tweaks.css

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart Hub: getting-started/quickstart.md
      - Pydantic Quickstart: getting-started/pydantic-quickstart.md
      - LangChain Quickstart: getting-started/langchain-quickstart.md
      - CLI: cli.md
  - Documentation:
      - Pydantic ACP:
          - Overview: pydantic-acp.md
          - AdapterConfig: pydantic-acp/adapter-config.md
          - Session State and Lifecycle: pydantic-acp/session-state.md
          - Models, Modes, and Slash Commands: pydantic-acp/runtime-controls.md
          - Plans, Thinking, and Approvals: pydantic-acp/plans-thinking-approvals.md
          - Prompt Resources and Context: pydantic-acp/prompt-resources.md
          - Providers: providers.md
          - Bridges: bridges.md
          - Host Backends and Projections: host-backends.md
      - LangChain ACP:
          - Overview: langchain-acp.md
          - AdapterConfig: langchain-acp/adapter-config.md
          - Session State and Lifecycle: langchain-acp/session-state.md
          - Models, Modes, and Config: langchain-acp/runtime-controls.md
          - Plans, Thinking, and Approvals: langchain-acp/plans-thinking-approvals.md
          - Prompt Resources and Context: langchain-acp/prompt-resources.md
          - Providers: langchain-acp/providers.md
          - Bridges: langchain-acp/bridges.md
          - Projections and Event Projection Maps: langchain-acp/projections.md
      - Helpers:
          - Overview: helpers.md
          - ACP Remote Overview: acpremote.md
      - Integration Audit: integration-audit.md
      - Integration Testing: integration-testing.md
      - Compatibility Matrix Template: compatibility-matrix-template.md
      - Projection Cookbook: projection-cookbook.md
      - Integration Readiness: integration-readiness.md
  - Examples:
      - Overview: examples/index.md
      - Finance Agent: examples/finance.md
      - Travel Agent: examples/travel.md
      - Codex-Backed LangChain Graph: examples/langchain-codex.md
      - LangChain Workspace Graph: examples/langchain-workspace.md
      - DeepAgents Compatibility Example: examples/deepagents.md
      - Remote ACP Hosting: examples/remote-hosting.md
      - Dynamic Factory Agents: examples/dynamic-factory.md
  - API Reference:
      - acpkit: api/acpkit.md
      - acpremote: api/acpremote.md
      - langchain_acp: api/langchain_acp.md
      - pydantic_acp: api/pydantic_acp.md
      - codex_auth_helper: api/codex_auth_helper.md
  - Testing: testing.md
  - About: about/index.md