Sireno Deck Documentation
Welcome to the Sireno Deck documentation. This documentation is designed to be consumed by an Astro website and provides comprehensive guides for both end users and developers.
Audience Routing
Section titled “Audience Routing”Choose your path:
For End Users
Section titled “For End Users”If you want to install, configure, and use Sireno Deck:
- Installation Guide — Set up Sireno Deck on your system
- Running the Service — CLI commands and daemon management
- Configuration Files — config.yml reference and syntax
- Decks and Buttons — Understanding deck structure
- Actions Reference — How button actions work
- Text Formatting — Rich text tags like
<xl>,<primary> - Icons — Using the icon system
- Built-in Addons — Reference for all bundled addons
- Themes — Customizing the visual appearance
For Developers
Section titled “For Developers”If you want to extend Sireno Deck with addons or themes:
- Architecture Overview — System design and data flows
- Protocol Reference — WebSocket message formats
- Runtime API — Programmatic deck control
- Addon Authoring — Creating custom addons
- Theme Authoring — Creating custom themes
Reference
Section titled “Reference”- Config Schema — Complete config.yml reference
- Addon API — TypeScript interfaces for addon development
- CLI Commands — Every command and flag
- Text Tags — All supported formatting tags
- Macro Syntax — Keyboard shortcut expressions
Quick Links
Section titled “Quick Links”This documentation is versioned and portable. It can be consumed by any Astro project using MDX content collections.