Relay Docs
  • Overview
  • Docs
  • GitHub ↗
Docs/Design/Design
Documentation
  • Changelog
  • Documentation update log
  • Overview
Usage
  • Conformance testing
  • Declarative operations
  • Operations and migrations
  • Production Hardening
  • Quickstart
Manual & Runbooks
  • Web Dashboard Manual Acceptance Checklist
Architecture
  • Components
  • Data-plane access via SDK client
  • Recovery
Design
  • Compatibility tiers
  • Goals and non-goals
  • Terminology
Protocols
  • Conductor Protocol (WebSocket)
  • Wire to REST Mapping
Testing
  • Multi-SDK verification matrix
Discovery
  • Conformance Batteries Specification
  • Dashboard component reuse evaluation
  • Metrics, alerting, and HA peer forwarding
  • Permission model and API key format
  • Provenance ledger
  • REST API surface and operation inventory
  • Recovery timing parameters and application configuration
  • Upstream client behaviour and conformance checklist
Decisions
  • ADR 0001 - Clean-room derivation from permitted sources
  • ADR 0002 - MIT licence and naming constraints
  • ADR 0003 - Implementation language
  • ADR 0004 - Optional data-plane access via SDK client
  • ADR 0005 - Reject standalone executor-impersonating sidecar
  • ADR 0006 - Reject tsnet executor connectivity tunnel
  • ADR 0007 - Reject native Postgres extension
  • ADR 0008 - Alerting Rule Types Alignment with OpenAPI Specification
  • ADR 0010 - Redistribution of OpenAPI interface specifications
  • ADR 0011 - Dual-engine storage architecture and embedded mode
  • Dashboard web stack
Contribution
  • Clean-room rules
  • Contributor guide
  • Maintainer guide

Design

  • Goals and non-goals - what v1 covers and what it refuses
  • Compatibility tiers - the gates that order the work
  • Terminology - the vocabulary used throughout the wiki