diff --git a/.Jules/palette.md b/.Jules/palette.md index fecc08d..be28981 100644 --- a/.Jules/palette.md +++ b/.Jules/palette.md @@ -6,3 +6,8 @@ This journal contains critical UX/accessibility learnings discovered during the **Learning:** For infrastructure or backend projects without a functional frontend, the `README.md` serves as the primary User Experience (DX/UX). In these cases, micro-UX improvements shift from ARIA labels to scannability, clarity of project status, and informative (non-redundant) feature lists. **Action:** Treat the `README.md` as the landing page. Use visual status indicators (badges), scannable bullet points with representative emojis, and ensure that headers provide a clear path for the user to understand the project's utility and maturity. + +## 2026-05-19 - Visual Hierarchy in Architecture Diagrams +**Learning:** In infrastructure documentation, complex "dual nature" systems benefit from a central visual anchor. Using specific Mermaid styles (double-circle nodes and distinctive colors) for the core orchestration component creates an immediate focal point that anchors the surrounding layers. + +**Action:** Use `node((Name))` syntax and `style Name fill:#f96,stroke-width:4px` to distinguish primary orchestration nodes in architecture diagrams for better visual scannability. diff --git a/README.md b/README.md index 80d6c39..e161bf8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # ⚖️ arbiter -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -![Status: Experimental](https://img.shields.io/badge/Status-Experimental-orange) +[![License: MIT - Open source software license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +![Project Status: Experimental - Not recommended for production use](https://img.shields.io/badge/Status-Experimental-orange) + +> [!CAUTION] +> This project is currently **Experimental**. It is not recommended for production use as APIs and core functionality are subject to significant change. Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM pinning) with quantum-accelerated Kubernetes scheduling. @@ -9,6 +12,34 @@ Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM `arbiter` is a specialized orchestration layer designed for high-performance computing environments. It bridges the gap between low-level hardware management and cloud-native scheduling, providing a unified interface for managing virtualized resources with precision. +## 🏗️ Architecture + +```mermaid +graph TD + subgraph CloudNative [Cloud Native Layer] + K8s[Kubernetes Cluster] + Workloads[AI Workloads] + end + + subgraph Orchestration [Orchestration Layer] + Arbiter((Arbiter Core)) + Scheduler[Quantum-Accelerated Scheduler] + end + + subgraph Infrastructure [Infrastructure Layer] + BareMetal[Bare-Metal Hardware] + aSHARD[aSHARD VRAM Pinning] + end + + Workloads --> K8s + K8s <--> Arbiter + Arbiter <--> Scheduler + Arbiter <--> aSHARD + aSHARD --> BareMetal + + style Arbiter fill:#f96,stroke:#333,stroke-width:4px +``` + ## 🚀 Key Features - 🏗️ **Infrastructure Awareness**: Directly manages bare-metal resources for maximum performance.