mirror of
https://github.com/blackboxprogramming/BlackRoad-Operating-System.git
synced 2026-03-17 03:57:13 -05:00
124 lines
3.4 KiB
YAML
124 lines
3.4 KiB
YAML
site_name: BlackRoad OS Codex
|
|
site_description: Complete documentation for BlackRoad Operating System - Where AI meets the open road
|
|
site_author: BlackRoad Team
|
|
site_url: https://docs.blackroad.systems
|
|
|
|
repo_name: blackboxprogramming/BlackRoad-Operating-System
|
|
repo_url: https://github.com/blackboxprogramming/BlackRoad-Operating-System
|
|
edit_uri: edit/main/codex-docs/docs/
|
|
|
|
copyright: Copyright © 2025 BlackRoad OS
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
# Light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
# Dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.action.edit
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
logo: material/road
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/blackboxprogramming/BlackRoad-Operating-System
|
|
- icon: fontawesome/brands/discord
|
|
link: https://discord.gg/blackroad # Discord: Coming in Phase 1 Q2 (community hub)
|
|
version:
|
|
provider: mike
|
|
analytics:
|
|
provider: google
|
|
property: G-XXXXXXXXXX # TODO: Add Google Analytics ID
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Architecture:
|
|
- Overview: architecture/overview.md
|
|
- Phase 2.5 Decisions: architecture/phase2-decisions.md
|
|
- Infrastructure & Deployment: architecture/infra-deployment.md
|
|
- API Reference:
|
|
- Overview: api/overview.md
|
|
- Authentication: api/authentication.md
|
|
- Prism Console: api/prism.md
|
|
- Blockchain: api/blockchain.md
|
|
- Guides:
|
|
- Quick Start: guides/quickstart.md
|
|
- Deployment Guide: guides/deployment.md
|
|
- Development Setup: guides/development.md
|
|
- Environment Variables: guides/environment-variables.md
|
|
- Agents:
|
|
- Overview: agents/overview.md
|
|
- Creating Agents: agents/creating-agents.md
|
|
- Agent Categories: agents/categories.md
|
|
- Contributing: contributing.md
|