Add project documentation, architecture decisions, and usage book
Comprehensive documentation for WayRay, a SunRay-like thin client
Wayland compositor targeting illumos and Linux:
- CLAUDE.md: project context and conventions
- docs/ai/plans: 6-phase implementation roadmap
- docs/ai/adr: 9 architecture decision records (Smithay, QUIC,
frame encoding, session management, rendering, audio, project
structure, illumos support, pluggable window management)
- docs/architecture: system architecture overview with diagrams
- docs/protocols: WayRay wire protocol specification
- book/: mdbook user guide (introduction, concepts, server/client
guides, admin, development)
- RESEARCH.md: deep research on remote display protocols
2026-03-28 20:47:16 +01:00
|
|
|
# Summary
|
|
|
|
|
|
|
|
|
|
[Introduction](./introduction.md)
|
|
|
|
|
|
|
|
|
|
# Getting Started
|
|
|
|
|
|
|
|
|
|
- [Overview](./overview.md)
|
|
|
|
|
- [Installation](./installation.md)
|
|
|
|
|
- [Quick Start](./quickstart.md)
|
|
|
|
|
|
|
|
|
|
# Concepts
|
|
|
|
|
|
|
|
|
|
- [Architecture](./concepts/architecture.md)
|
|
|
|
|
- [Session Mobility](./concepts/session-mobility.md)
|
|
|
|
|
- [Display Encoding](./concepts/display-encoding.md)
|
|
|
|
|
- [Network Transport](./concepts/network-transport.md)
|
|
|
|
|
- [Pluggable Window Management](./concepts/pluggable-wm.md)
|
|
|
|
|
|
|
|
|
|
# Server Guide
|
|
|
|
|
|
|
|
|
|
- [Server Configuration](./server/configuration.md)
|
|
|
|
|
- [Running the Server](./server/running.md)
|
|
|
|
|
- [Multi-Server Setup](./server/multi-server.md)
|
|
|
|
|
- [Session Management](./server/sessions.md)
|
|
|
|
|
|
|
|
|
|
# Client Guide
|
|
|
|
|
|
|
|
|
|
- [Client Configuration](./client/configuration.md)
|
|
|
|
|
- [Connecting to a Server](./client/connecting.md)
|
|
|
|
|
- [Token Setup](./client/tokens.md)
|
|
|
|
|
- [Audio & USB](./client/peripherals.md)
|
|
|
|
|
|
|
|
|
|
# Administration
|
|
|
|
|
|
2026-03-29 00:34:19 +01:00
|
|
|
- [wradm Reference](./admin/wradm.md)
|
Add project documentation, architecture decisions, and usage book
Comprehensive documentation for WayRay, a SunRay-like thin client
Wayland compositor targeting illumos and Linux:
- CLAUDE.md: project context and conventions
- docs/ai/plans: 6-phase implementation roadmap
- docs/ai/adr: 9 architecture decision records (Smithay, QUIC,
frame encoding, session management, rendering, audio, project
structure, illumos support, pluggable window management)
- docs/architecture: system architecture overview with diagrams
- docs/protocols: WayRay wire protocol specification
- book/: mdbook user guide (introduction, concepts, server/client
guides, admin, development)
- RESEARCH.md: deep research on remote display protocols
2026-03-28 20:47:16 +01:00
|
|
|
- [Security](./admin/security.md)
|
|
|
|
|
- [Monitoring](./admin/monitoring.md)
|
|
|
|
|
- [Troubleshooting](./admin/troubleshooting.md)
|
|
|
|
|
|
|
|
|
|
# Development
|
|
|
|
|
|
|
|
|
|
- [Building from Source](./dev/building.md)
|
|
|
|
|
- [Protocol Reference](./dev/protocol.md)
|
|
|
|
|
- [Contributing](./dev/contributing.md)
|
