Sheltie docs
Everything here is generated from the Markdown files in the repository, so it always matches the code.
Getting started
Install Sheltie with Docker, configure monitors and Telegram, and use the API.
Architecture
How Sheltie works today and the outage-resilient architecture it is moving towards.
Roadmap
Known issues, the resilience plan, the contributor backlog and the release timeline.
Design system
Sheltie's UX principles, invariants, Ink & Cream tokens and component rules.
Feature comparison
How Sheltie compares with Uptime Kuma, Beszel, Gatus, Netdata and healthchecks.io.
UX comparison
How Sheltie's user experience compares with other homelab monitoring tools, and what it still lacks.
Name and brand
Why Meerkat became Sheltie, the search plan, the visual identity and how to migrate.
Contributing
Set up a development environment and send your first pull request.
Rules for AI agents
What automated coding agents must and must not change in Sheltie.
Security
How to report vulnerabilities and harden your Sheltie install.