Skip to content

🎨 Palette: Enhance architecture diagram and documentation accessibility #67

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: Enhance architecture diagram and documentation accessibility #67

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
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,35 @@ Dual nature—combining bare-metal virtualized hardware management (aSHARD VRAM
## 🏗️ Architecture

```mermaid
--- title: Arbiter System Architecture ---

@chatgpt-codex-connector chatgpt-codex-connector Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Split Mermaid frontmatter delimiters onto their own lines

This puts the Mermaid title metadata on the same line as the --- delimiters. Mermaid's frontmatter syntax requires the triple dash to be the only content on the delimiter line, so this line is not recognized as valid frontmatter and becomes an unknown statement before graph TD, causing the README architecture diagram to fail to render in Mermaid/GitHub contexts. Split this into ---, title: Arbiter System Architecture, and --- before the graph declaration. See the Mermaid syntax docs: https://mermaid.ai/open-source/intro/syntax-reference.html#frontmatter-for-diagram-code

Useful? React with 👍 / 👎.

@gemini-code-assist gemini-code-assist Bot Jun 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The Mermaid frontmatter syntax is incorrect. Mermaid requires the frontmatter delimiters (---) to be on their own separate lines. A single-line format like --- title: ... --- will fail to render correctly in many Mermaid parsers, including GitHub's.

Please format the frontmatter block with separate lines.

Suggested change
--- title: Arbiter System Architecture ---
---
title: Arbiter System Architecture
---

graph TD
subgraph CloudNative [Cloud Native Layer]
K8s[Kubernetes Cluster]
WL([AI Workloads])
K8s([Kubernetes Cluster])
end

subgraph Orchestration [Orchestration Layer]
Arbiter((Arbiter Core))
QS[Quantum Scheduler]
QS{{Quantum Scheduler}}
end

subgraph Infrastructure [Infrastructure Layer]
VP{{aSHARD VRAM Pinning}}
BM[Bare Metal Hardware]
GPU[GPU Resources]
end

WL --> K8s
K8s <--> Arbiter
Arbiter <--> QS
Arbiter <--> BM
Arbiter <--> VP
VP <--> BM
BM --- GPU

style Arbiter fill:#f96,stroke-width:4px
style CloudNative stroke-dasharray: 5 5
style Orchestration stroke-dasharray: 5 5
style Infrastructure stroke-dasharray: 5 5
```

## 🚀 Key Features
Expand All @@ -47,7 +55,7 @@ graph TD

## 🧪 Context

`arbiter` was created by **Igor Holt** (AI Architect) as part of the **Genesis Conductor Engine**. It serves as the resource orchestration layer for AI workloads, bridging low-level hardware management with cloud-native scheduling to ensure optimal utilization of specialized compute resources.
`arbiter` was created by **Igor Holt** (AI Architect) as part of the [**Genesis Conductor Engine**](https://genesisconductor.io "Genesis Conductor Engine - Official Website"). It serves as the resource orchestration layer for AI workloads, bridging low-level hardware management with cloud-native scheduling to ensure optimal utilization of specialized compute resources.

## ⚖️ License

Expand Down