Files
blackroad-operating-system/codex-docs/mkdocs.yml
Claude e84407660d feat: scaffold BlackRoad OS Phase 2 infrastructure
Implements complete Phase 2 scaffold across 6 core modules:

## New Modules

### 1. Backend API Enhancements
- Add system router with /version, /config/public, /os/state endpoints
- Register system router in main.py
- Add comprehensive tests for system endpoints

### 2. Core OS Runtime (core_os/)
- Implement UserSession, Window, OSState models
- Add state management functions (open_window, close_window, etc.)
- Create Backend API adapter for communication
- Include full test suite for models and state

### 3. Operator Engine (operator_engine/)
- Build job registry with example jobs
- Implement simple scheduler with lifecycle management
- Optional HTTP server on port 8001
- Complete tests for jobs and scheduler

### 4. Web Client Enhancements
- Add CoreOSClient JavaScript class
- Integrate system API endpoints
- Event-driven architecture for state updates
- Zero dependencies, vanilla JavaScript

### 5. Prism Console (prism-console/)
- Modern dark-themed admin UI
- Multi-tab navigation (Overview, Jobs, Agents, Logs, System)
- Real-time metrics dashboard
- Backend API integration with auto-refresh

### 6. Documentation (codex-docs/)
- Complete MkDocs-based documentation
- Architecture guides and component docs
- Infrastructure setup guides
- API reference documentation

## CI/CD

- Add core-os-tests.yml workflow
- Add operator-tests.yml workflow
- Add docs-build.yml workflow

## Documentation

- Create BLACKROAD_OS_REPO_MAP.md cross-reference
- Add README for each module
- Comprehensive integration documentation

## Summary

- 37 new files created
- ~3,500 lines of new code
- 5 test suites with 15+ tests
- 3 new CI workflows
- 10+ documentation pages

All modules are minimal working skeletons ready for integration.
Designed to be extracted into separate repos if needed.

Phase 2 scaffold complete and ready for review.
2025-11-18 03:47:13 +00:00

76 lines
1.9 KiB
YAML

site_name: BlackRoad OS Codex
site_description: Complete documentation for BlackRoad Operating System
site_author: BlackRoad OS Team
site_url: https://blackroad.systems/docs
theme:
name: material
palette:
- scheme: slate
primary: indigo
accent: purple
toggle:
icon: material/brightness-4
name: Switch to light mode
- scheme: default
primary: indigo
accent: purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
features:
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
nav:
- Home: index.md
- Architecture:
- Overview: architecture.md
- 7-Layer Stack: architecture-layers.md
- Components: components.md
- Infrastructure:
- Overview: infra.md
- Cloudflare Setup: infra-cloudflare.md
- Railway Deployment: infra-railway.md
- GitHub Configuration: infra-github.md
- Modules:
- Backend API: modules/backend-api.md
- Core OS Runtime: modules/core-os.md
- Operator Engine: modules/operator.md
- Web Client (Pocket OS): modules/web-client.md
- Prism Console: modules/prism.md
- Development:
- Getting Started: dev/getting-started.md
- Local Setup: dev/local-setup.md
- Contributing: dev/contributing.md
- API Reference:
- System Endpoints: api/system.md
- Authentication: api/auth.md
- Agents: api/agents.md
markdown_extensions:
- admonition
- codehilite
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.tabbed
- toc:
permalink: true
plugins:
- search
- mkdocstrings
extra:
version: 0.1.0
social:
- icon: fontawesome/brands/github
link: https://github.com/blackboxprogramming/BlackRoad-Operating-System