microbots/mkdocs.yml at main · microsoft/microbots · 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
site_name: Microbots
site_url: https://microsoft.github.io/microbots
site_description: A lightweight, extensible AI agent for code comprehension and controlled file edits.
repo_url: https://github.com/microsoft/microbots
repo_name: microsoft/microbots

theme:
  name: zensical
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.top
    - navigation.tabs
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: alphabetical
            docstring_style: numpy
            show_if_no_docstring: true
            show_labels: true
            show_bases: true
            show_signature: true
            show_signature_annotations: true
            merge_init_into_class: true

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: ['.', 'docs']
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - attr_list
  - md_in_html

nav:
  - Introduction: index.md
  - Getting Started:
    - "Pre-requisites": getting-started/prerequisites.md
    - "Project Setup and Microbots Installation": getting-started/project-setup-and-installation.md
    - "Create Your First Microbot Project": getting-started/create-your-first-microbot-project/index.md
    - "Microbots Execution Flow": getting-started/microbots-execution-flow.md
    - "Configure Logging in Microbots": getting-started/microbots-logging.md
  - Advanced:
    - Bots:
      - CopilotBot: advanced/bots/copilot-bot.md
    - "Authentication Setup": advanced/authentication.md
    - "Azure Managed Identity & Service Connection Setup": advanced/azure-managed-identity-setup.md
    - Tools:
      - "Custom Tool Integration Walkthrough": advanced/tools/tesseract_ocr_tool_use.md
    - "Technical Writing Guidelines": advanced/technical-writing-guidelines.md
  - Blog:
    - "Blog Posts": blog/index.md
    - "Microbots : Safety First Agentic Workflow": blog/microbots-safety-first-ai-agent.md
    - "Microbots : Customizability at Every Layer": blog/microbots-customizability.md
    - "Understanding RBAC & Authentication": blog/rbac-authentication.md
  - API Reference:
    - MicroBot: api-reference/microbots/MicroBot.md
    - bot:
      - AgentBoss: api-reference/microbots/bot/AgentBoss.md
      - BrowsingBot: api-reference/microbots/bot/BrowsingBot.md
      - CopilotBot: api-reference/microbots/bot/CopilotBot.md
      - LogAnalysisBot: api-reference/microbots/bot/LogAnalysisBot.md
      - ReadingBot: api-reference/microbots/bot/ReadingBot.md
      - WritingBot: api-reference/microbots/bot/WritingBot.md
    - environment:
      - Environment: api-reference/microbots/environment/Environment.md
      - local_docker:
        - LocalDockerEnvironment: api-reference/microbots/environment/local_docker/LocalDockerEnvironment.md
        - image_builder:
          - dockerShell: api-reference/microbots/environment/local_docker/image_builder/dockerShell.md
          - ShellCommunicator: api-reference/microbots/environment/local_docker/image_builder/ShellCommunicator.md
    - extras:
      - mount: api-reference/microbots/extras/mount.md
    - llm:
      - anthropic_api: api-reference/microbots/llm/anthropic_api.md
      - llm: api-reference/microbots/llm/llm.md
      - ollama_local: api-reference/microbots/llm/ollama_local.md
      - openai_api: api-reference/microbots/llm/openai_api.md
    - tools:
      - external_tool: api-reference/microbots/tools/external_tool.md
      - internal_tool: api-reference/microbots/tools/internal_tool.md
      - tool: api-reference/microbots/tools/tool.md
      - tool_yaml_parser: api-reference/microbots/tools/tool_yaml_parser.md
      - tool_definitions:
        - memory_tool: api-reference/microbots/tools/tool_definitions/memory_tool.md
        - microbot_sub_agent: api-reference/microbots/tools/tool_definitions/microbot_sub_agent.md
    - utils:
      - copilot_auth: api-reference/microbots/utils/copilot_auth.md
      - logger: api-reference/microbots/utils/logger.md
      - multi_agent_log_parser: api-reference/microbots/utils/multi_agent_log_parser.md
      - network: api-reference/microbots/utils/network.md
      - path: api-reference/microbots/utils/path.md
    - constants: api-reference/microbots/constants.md
    - "Docstring Guide": api-reference-guide.md

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/lightbox.js
  - javascripts/doc-anchors.js