Hearth Docs

Installation, operations, displays, and module development in one place.

This is the public documentation surface for Hearth. It explains what the system does, how to run it, how displays behave, and how to build new SDK modules without reintroducing timing and caching regressions.

Highlights

• Display runtime plus admin UI in one web app
• Astro-based public docs site deployed to GitHub Pages
• Synced household time for site-local behavior
• SDK-first module architecture
• Single supported verification path with pnpm verify

Start here

• What Hearth does
• Install and run locally
• How the application is organised
• Use the admin app
• Deploy to Synology
• Build modules
• Write time-safe modules
• Test and verify changes

Links

• GitHub repository
• Markdown mirror