Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryoku.dev/llms.txt

Use this file to discover all available pages before exploring further.

Ryoku is an opinionated Arch Linux desktop targeted at security work: a Niri tiling compositor, a custom Quickshell UI, hardened defaults, and a signed offline ISO that boots and installs without network access. It started as a fork of Omarchy and has diverged on the desktop, theming, and release pipeline.

Start here

What Ryoku is

Goals, audience, and non-goals. Read this first if you’re evaluating Ryoku.

Build the ISO

Working recipe for producing the offline ISO end to end.

Release pipeline

How signed ISOs are built, published, and verified.

Heritage from Omarchy

What survives from upstream Omarchy and what’s been removed.

Reference

Keybindings

Niri and shell keyboard reference, generated from the shipped config.

UI patterns

Quickshell desktop conventions. Read before touching anything under shell/.

Customization inventory

Where the user-facing customization surfaces live in the repo.

Branding

Greek Noir palette, logo files, and where the brand surfaces.

Contributing

The project is early. The maintenance guide covers the branch topology and safety rules; CONTRIBUTING lists focused ways to help. Security-sensitive issues go through the private path in SECURITY.