From 717716adf2cce525e585362568817db61fa0f957 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sat, 9 May 2026 05:17:20 +0000 Subject: [PATCH] feat(docs): enhance README accessibility and clarity - Add Mermaid architecture diagram - Upgrade experimental status to high-visibility alert - Improve badge accessibility with titles and descriptive alt-text Co-authored-by: igor-holt <125706350+igor-holt@users.noreply.github.com> --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80d6c39..41f5ac9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # ⚖️ 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](https://img.shields.io/badge/License-MIT-yellow.svg "License: MIT - Open source software license")](https://opensource.org/licenses/MIT) + +> [!CAUTION] +> This project is currently **Experimental**. It is not recommended for production use. Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM pinning) with quantum-accelerated Kubernetes scheduling. @@ -9,6 +11,30 @@ 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 "Cloud Native" + K8s[Kubernetes Cluster] + end + + subgraph "Orchestration" + Arbiter((Arbiter Core)) + end + + subgraph "Infrastructure" + Hardware[Bare Metal / Virtualized HW] + aSHARD[aSHARD VRAM Pinning] + end + + K8s --- Arbiter + Arbiter --- Hardware + Hardware --- aSHARD + + style Arbiter fill:#f96,stroke-width:4px +``` + ## 🚀 Key Features - 🏗️ **Infrastructure Awareness**: Directly manages bare-metal resources for maximum performance.