mirror of
https://github.com/blackboxprogramming/BlackRoad-Operating-System.git
synced 2026-03-17 03:57:13 -05:00
e84407660d
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.
64 lines
1.3 KiB
Markdown
64 lines
1.3 KiB
Markdown
# BlackRoad OS Codex
|
|
|
|
Complete documentation for BlackRoad Operating System, built with MkDocs.
|
|
|
|
## Building the Docs
|
|
|
|
### Install Dependencies
|
|
|
|
```bash
|
|
pip install mkdocs mkdocs-material mkdocstrings pymdown-extensions
|
|
```
|
|
|
|
### Serve Locally
|
|
|
|
```bash
|
|
cd codex-docs
|
|
mkdocs serve
|
|
```
|
|
|
|
Visit `http://localhost:8000`
|
|
|
|
### Build Static Site
|
|
|
|
```bash
|
|
mkdocs build
|
|
```
|
|
|
|
Output in `site/` directory.
|
|
|
|
### Deploy to GitHub Pages
|
|
|
|
```bash
|
|
mkdocs gh-deploy
|
|
```
|
|
|
|
## Structure
|
|
|
|
```
|
|
codex-docs/
|
|
├── mkdocs.yml # Configuration
|
|
├── docs/ # Documentation source
|
|
│ ├── index.md # Homepage
|
|
│ ├── architecture.md # Architecture guide
|
|
│ ├── components.md # Component overview
|
|
│ ├── infra.md # Infrastructure
|
|
│ ├── modules/ # Module docs
|
|
│ ├── dev/ # Development guides
|
|
│ └── api/ # API reference
|
|
└── site/ # Built site (gitignored)
|
|
```
|
|
|
|
## Features
|
|
|
|
- **Material Theme** - Modern, responsive design
|
|
- **Dark Mode** - Light/dark theme toggle
|
|
- **Search** - Full-text search
|
|
- **Code Highlighting** - Syntax highlighting for all languages
|
|
- **Navigation** - Tabbed navigation with sections
|
|
- **Mobile Friendly** - Responsive design
|
|
|
|
## License
|
|
|
|
Part of BlackRoad Operating System - MIT License
|