> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pcnaid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HouseholdOS developer documentation

> Build, verify, and integrate with the HouseholdOS source application.

# HouseholdOS developer documentation

HouseholdOS combines a single-page browser application with a service that handles authentication, HTTP routes, persistence, and scheduled household processing. The product also has a separate public marketing site and contact endpoint.

> [!NOTE]
>
> This documentation is an inventory of the reviewed source snapshot. It does not assert that the live deployment matches that snapshot.

## Repository workflow

Local environment configuration, contributor commands, and deployment instructions are intentionally omitted from this public guide. Changes are verified with type, lint, test, data-isolation, and production-build checks before release.

## Integration map

| Area | Implemented integration |
| - | - |
| Identity | Hosted sign-in with a same-origin application session and supported non-browser credentials |
| Database | Relational storage with household data isolation |
| Files | Authorized file upload and download |
| Cache | Optional application caching |
| Messaging | Transactional email and SMS routes |
| Calendar | Household iCalendar export |
| AI | Responses through a configured AI service |
| Telemetry | Product analytics and error monitoring |
| Marketing contact | Validated contact submissions with optional team notification |

> **[Architecture overview](https://docs.pcnaid.com/nodes/web-apps/householdos/developer/architecture-overview.md)**
>
> Trace entry points, SPA routes, authentication, storage, and deployment shape.

> **[HTTP route inventory](https://docs.pcnaid.com/nodes/web-apps/householdos/developer/api.md)**
>
> Review every route dispatched by the Worker in this source snapshot.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.