Public docs

June 16, 2026 ยท View on GitHub

This folder contains the public-facing documentation for role-model.

It is intentionally separated from the rest of docs/ so a future docs site can use docs/public/ as its content root while the existing protocol and architecture material remains available as deeper reference documentation.

Start here

  1. Introduction
  2. Install the router
  3. Quickstart
  4. How role-model works
  5. Protocol overview
  6. Routing overview

What these docs cover

These pages are optimized for a new external technical reader who wants to understand:

  • what role-model is
  • what problem it solves
  • how the system works end to end
  • what the protocol owns
  • how routing decisions are made and explained

What stays in reference docs

The public docs summarize and link to the deeper reference material instead of duplicating it.

Suggested reading paths

PathBest for
Introduction -> Install the router -> Quickstartfirst-time readers
Introduction -> Protocol overviewprotocol/design readers
Introduction -> How role-model works -> Routing overviewrouting and system readers