Developers¶
Contributor-facing docs. Operator guides live in the rest of this site.
What this is¶
How to run PiHerder from source, understand architecture, extend templates, test, publish images, and maintain the wiki.
Why separate from operator docs¶
Operators need “what / why / how on a running instance.” Developers need setup, schemas, and contribution rules without cluttering the day-to-day nav.
| Topic | Page |
|---|---|
| Local setup (+ dep locks) | setup |
| Architecture | architecture |
| Template schema | templates-schema |
| Testing | testing |
| Publish image | publish-image |
| Wiki, screenshots, doc versioning & 1.0 | contributing-docs |
Collaboration¶
Public contributors may open Issues and Pull Requests. Only the project maintainer merges to main. See CONTRIBUTING.md.
To fund development and the public demo (optional): GitHub Sponsors and Buy me a coffee — Support the project.
Repo maintainer docs (not in this nav)¶
| Path | Role |
|---|---|
SPEC.md | Canonical phase checklist |
docs/ROADMAP_ECOSYSTEM.md | Multi-horizon roadmap |
docs/PLAN_v*.md | Release plans |
docs/FEATURE_PLAN_*.md | Feature design notes (maintainer) |
docs/RELEASE_v*.md | Release notes |
docs/DECISION_*.md | Locked decisions |
Stack¶
FastAPI · SQLModel · PostgreSQL · Paramiko · Fernet · Jinja2 · HTMX · Alpine · compiled Tailwind · APScheduler · Celery · Caddy