finecode/mkdocs.yml at main · finecode-dev/finecode · 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
site_name: FineCode
site_description: Tool runner and extension framework for software developers
site_url: !ENV [MKDOCS_SITE_URL, 'http://localhost:8000']
repo_url: https://github.com/finecode-dev/finecode
repo_name: finecode-dev/finecode

theme:
  name: material
  logo: finecode_logo_white.png
  custom_dir: docs/overrides
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

extra_css:
  - stylesheets/extra.css

exclude_docs: |
  adr/template.md
  plans/

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
            - finecode_extension_api/src
            - finecode_extension_runner/src
            - finecode_jsonrpc/src
            - finecode_httpclient/src
            - finecode_builtin_handlers/src
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            docstring_style: google

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - toc:
      permalink: true

nav:
  - Getting Started:
      - Welcome to FineCode: index.md
      - Setup: getting-started.md
      - IDE and MCP Setup: getting-started-ide-mcp.md
  - Concepts:
      - Overview: concepts.md
      - Why FineCode's Action Model Works: theory/why-action-model.md
  - Configuration: configuration.md
  - CLI Reference: cli.md
  - Guides:
      - Creating an Extension: guides/creating-extension.md
      - Creating a Preset: guides/creating-preset.md
      - Designing Actions: guides/designing-actions.md
      - Preparing Environments: guides/preparing-environments.md
      - Multi-Project Workspace: guides/workspace.md
  - Reference:
      - Built-in Actions: reference/actions.md
      - Services: reference/services.md
      - Extensions: reference/extensions.md
      - LSP and MCP Architecture: reference/lsp-mcp-architecture.md
      - LSP Client Protocol: reference/lsp-protocol.md
      - Glossary: glossary.md
  - About: about.md
  - Development:
      - Overview: development.md
      - WM Protocol: wm-protocol.md
      - WM-ER Protocol: wm-er-protocol.md
      - Developing FineCode: guides/developing-finecode.md
      - Architecture Decisions: adr/README.md