Skip to content

🎨 Palette: [UX improvement] Enhance README DX with architecture diagram and accessibility polishes #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Igor Holt (igor-holt) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: [UX improvement] Enhance README DX with architecture diagram and accessibility polishes #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,43 @@
# ⚖️ 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)
![Status: Experimental](https://img.shields.io/badge/Status-Experimental-orange "Project Status: Experimental - Not recommended for production use")
Comment on lines +3 to +4
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The PR description states that the alt-text for the badges was made more descriptive, but the current changes only added a title attribute (the text in quotes). For optimal accessibility, the descriptive text should be placed in the alt attribute (the text within the square brackets), as screen readers primarily rely on this field.

I suggest updating the alt text to match the descriptive content provided in the title attribute to ensure the accessibility goals of this PR are met.

Suggested change
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg "License: MIT - Open source software license")](https://opensource.org/licenses/MIT)
![Status: Experimental](https://img.shields.io/badge/Status-Experimental-orange "Project Status: Experimental - Not recommended for production use")
[![License: MIT - Open source software license](https://img.shields.io/badge/License-MIT-yellow.svg "License: MIT - Open source software license")](https://opensource.org/licenses/MIT)
![Project Status: Experimental - Not recommended for production use](https://img.shields.io/badge/Status-Experimental-orange "Project Status: Experimental - Not recommended for production use")


> [!CAUTION]
> This project is currently **Experimental**. It is not recommended for production use and is subject to significant changes.

Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM pinning) with quantum-accelerated Kubernetes scheduling.

## 📖 Overview

`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))
end

subgraph Infrastructure [Infrastructure Layer]
BareMetal[Bare Metal Resources]
VRAM[aSHARD VRAM Pinning]
end

Workloads --> K8s
K8s <--> Arbiter
Arbiter --> BareMetal
Arbiter --> VRAM

style Arbiter fill:#f96,stroke-width:4px
```

## 🚀 Key Features

- 🏗️ **Infrastructure Awareness**: Directly manages bare-metal resources for maximum performance.
Expand Down