Archety Documentation

AI Companion Platform for iMessage - Documentation Hub

Quick Links

Guide	Description
Deployment Guide	Deploy your own instance
Environment Variables	Configuration reference
Railway Setup	Railway deployment steps
Frontend Routes	API endpoint reference
Security Checklist	Production security audit
Conversational Grounding Architecture	Claim-level grounding design and data flow
Grounding Metrics Plan	KPIs, event schema, and rollout guardrails

Documentation Structure

Core Documentation

Folder	Contents
architecture/	System design, routing, memory architecture
miniapps/	MiniApp framework, handlers, UI schema
workflows/	Automated background task system
edge/	Mac mini edge client integration
integrations/	Third-party service integrations

Implementation Guides

Folder	Contents
implementation/	Setup guides, feature implementations, Supabase RPC, migrations
operations/	Feature flags, secrets management

Reference

Folder	Contents
apis/	API endpoint specifications
testing/	Test guides and stress testing
archive/	Historical documentation

Product Specs & Decisions

• Product Requirements: See the PRD/ directory at the repository root for all product requirement documents
• Architecture Decision Records: See decisions/ for ADRs documenting key technical choices
• Glossary: See GLOSSARY.md for key terminology definitions
• Constitution: See CONSTITUTION.md for project principles