scriptostudio/mkdocs.yml at main · jetpax/scriptostudio · 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
site_name: ScriptO Studio Docs
site_url: https://scriptostudio.com/docs/
site_description: Documentation for ScriptO Studio - Program embedded devices with natural language
site_author: jetpax
repo_url: https://github.com/jetpax/scriptostudio
repo_name: jetpax/scriptostudio
edit_uri: edit/main/docs-src/

# Source and output directories
docs_dir: docs-src
site_dir: docs

theme:
  name: material
  palette:
    scheme: slate
    primary: teal
    accent: cyan
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - First ScriptO: getting-started/first-scripto.md
    - Connection: getting-started/connection.md
    - IDE Overview: getting-started/ide-overview.md
  - Device Setup:
    - Flashing Firmware: device-setup/flashing-firmware.md
    - Board Configurations: device-setup/board-configurations.md
    - Network Setup: device-setup/network-setup.md
    - Provisioning: device-setup/provisioning.md
  - User Guide:
    - File Manager: user-guide/file-manager.md
    - Editor Features: user-guide/editor-features.md
    - Terminal & REPL: user-guide/terminal-repl.md
    - System Information: user-guide/system-info.md
    - Settings: user-guide/settings.md
  - ScriptOs:
    - scriptos/index.md
    - Writing ScriptOs: scriptos/writing-scriptos.md
    - UI Plugin - Hello World: scriptos/ui-plugin-hello-world.md
  - Extensions:
    - extensions/index.md
    - Writing Extensions: extensions/writing-extensions.md
    - Extension API: extensions/extension-api.md
    - Device Libraries: extensions/device-libraries.md
    - Built-in Extensions: extensions/built-in-extensions.md
    - Versioning: extensions/versioning.md
  - AI Agent:
    - agent/index.md
    - Setup: agent/setup.md
    - Usage: agent/usage.md
  - Debugging:
    - debugging/index.md
    - Setting Breakpoints: debugging/breakpoints.md
    - Debug Console: debugging/debug-console.md
  - Troubleshooting:
    - Connection Issues: troubleshooting/connection.md
    - Memory & Performance: troubleshooting/memory.md
    - Common Errors: troubleshooting/errors.md
    - Debug Logging: troubleshooting/debug-logging.md
  - Developer:
    - Architecture: developer/architecture.md
    - Building from Source: developer/building-from-source.md
    - Contributing: developer/contributing.md
    - ESM Modules: developer/esm-modules.md
    - Keyboard Shortcuts: developer/shortcuts.md
    - MicroPython Reference: developer/micropython-reference.md
    - Registry: developer/registry.md
  - Protocol:
    - WebREPL Binary Protocol: protocol/webrepl-binary-protocol.md
    - WebRTC Transport: protocol/webrtc-transport.md
    - WebSocket Transport: protocol/websocket-transport.md
    - Message Types: protocol/message-types.md
  - Reference:
    - FAQ: reference/faq.md
    - Changelog: reference/changelog.md
    - Roadmap: reference/roadmap.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jetpax/scriptostudio