48 lines
2.9 KiB
Plaintext
48 lines
2.9 KiB
Plaintext
---
|
|
id: docs-home
|
|
title: BlackRoad OS Docs Home
|
|
slug: /
|
|
---
|
|
|
|
BlackRoad OS is an orchestration operating system that lets a single human orchestrator direct agents and services with verifiable evidence. It anchors work to PS-SHA∞ identities, runs verification pipelines for truth states, journals everything through RoadChain, and surfaces system health through Prism Console and the public web shell. The platform lives across multiple repositories but speaks one architectural language.
|
|
|
|
This hub participates in the shared **"BlackRoad OS - Master Orchestration"** project and is the canonical place to understand how the stack fits together, how to operate it, and why it exists.
|
|
|
|
## Choose your path
|
|
|
|
### Getting Started
|
|
- [Quick Start](/getting-started/quick-start) — run the docs locally and tour the repos.
|
|
- [FAQ](/getting-started/faq) — unblock common onboarding questions.
|
|
|
|
### Platform Guides
|
|
- [Core Overview](/platform/core/overview) — stack map, seasons, and primitives.
|
|
- [API Overview](/platform/api/overview) — HTTP surface exposed by `blackroad-os-api`.
|
|
- [Operator Runtime](/platform/operator/runtime) — how agents run and emit events.
|
|
- [Prism Console](/platform/prism-console/overview) — cockpit for system status, agents, finance, and events.
|
|
|
|
### Agent Catalog & Roles
|
|
- Generated from `agent-catalog/agents.yaml` at build time so every persona stays in sync.
|
|
- Visual org chart lives at `/org-chart` and updates with each catalog change.
|
|
|
|
### Packs
|
|
- [Finance pack](/packs/finance/overview) — treasury and billing automation with PS-SHA∞ evidence.
|
|
- [Education pack](/packs/education/overview) — learning workflows tailored for compliance-heavy orgs.
|
|
|
|
### Reference
|
|
- [OpenAPI](/reference/openapi) — rendered via Redoc from `blackroad-os-api`.
|
|
- [CLI](/reference/cli) — docs hub commands and environment variables.
|
|
- [Agents: Atlas and Friends](/platform/core/agents-atlas-and-friends) — how agents register, identify, and report state.
|
|
- [Events and RoadChain](/platform/core/events-and-roadchain) — journaling, blocks, and how the explorer will work.
|
|
|
|
### Understand the Why
|
|
- [Pain Points Summary](/packs/finance/pain-points) — problems BlackRoad OS is built to solve.
|
|
- [Value Proposition](/packs/finance/value-proposition) — benefits for creators, teams, and partners.
|
|
- [Seasons Overview](/platform/core/seasons) — how the roadmap is structured.
|
|
|
|
## Quick orientation
|
|
- [BlackRoad OS Overview](/platform/core/overview) — the layered picture from identity to interface.
|
|
- [Stack Map](/platform/core/stack-map) — repositories mapped to layers and status.
|
|
- [Getting Started](/getting-started/quick-start) — run the docs locally and clone the stack.
|
|
|
|
BlackRoad OS is designed to stay honest about its current state. Pages mark components as planned, alpha, or in-flight so operators, developers, and partners know where to invest. Feedback and contributions are welcome—iterate with small, linked docs instead of monolithic walls of text.
|