Loryth Documentation¶

Welcome to the official documentation for the Loryth project — a microservices-based personal productivity platform built with FastAPI, React, and PostgreSQL.

Documentation Sections¶

Getting Started¶

• Quick Start — Clone, build, and run the platform with Docker Compose

Product¶

Product documentation defining who we build for and what we build.

• Overview — Product documentation hub
• Personas — Who uses Loryth
• User Stories — What users need
• Requirements — Detailed feature requirements

Platform¶

Project-wide planning, architecture, and infrastructure documentation.

• Vision — Overall vision and goals
• Tasks — Current tasks and status
• Infrastructure — Docker Compose guide
• Roadmap — Development plans and release milestones
• Architecture Decision Records — Key architectural decisions
• Technical Design — Detailed technical design documents

Libraries¶

Shared Python libraries powering all Loryth services.

• loryth-common — DI framework, collections, observability, and core utilities
• loryth-domain — Domain-driven design base classes, event sourcing, and outbox pattern
• loryth-fastapi — FastAPI extensions: middleware, response models, and schema helpers
• loryth-messages — Messaging abstractions and RabbitMQ integration
• loryth-persistence — Database persistence: repositories, transactions, and session management

Services¶

Microservices forming the Loryth platform.

• loryth-grocery — Food management: ingredients, recipes, inventory, and shopping trips
• loryth-iam — Identity and Access Management
• loryth-cms — Content Management System
• loryth-issues — Issue Tracking System
• loryth-journal — Journaling service
• loryth-wallet — Financial tracking service

UI¶

Coming in a future phase — documentation for the React frontend.

Contributing¶

• Documentation Guidelines — How to write technical designs, compression best practices, and quick-reference checklist

Templates¶

Canonical templates for project documentation.

• TD Template — Technical Design document template
• ADR Template — Architecture Decision Record template
• Persona Template — Persona document template
• PRD Template — Product Requirements Document template
• User Story Template — User story epic template

Building the Documentation¶

This documentation is built using MkDocs with the Material theme.

To serve the documentation locally via Docker:

docker compose --profile docs up docs

Then open your browser to http://localhost:8080 to view the documentation.