rely/docs

Documentation Index

Start here when taking over the app:

• Onboarding: first-day setup, mental model, and where to look.
• Architecture: module boundaries, state flow, and design decisions.
• Data Model: persisted local state and important domain models.
• Feature Map: product slices, canonical files, and common extension points.
• Share Intake: iOS/Android share entry, parsing, inbox, and timestamp handling.
• AI Digest: LLM providers, privacy model, prompts, digest lifecycle, and review workflow.
• Storage And Migrations: Hive, legacy shared preferences, schema versioning, and migration rules.
• Sync And Backend: fake/REST gateway boundary, sync queue, OpenAPI contract, and repair flow.
• Implementation Playbook: example feature implementation and files to update.
• Testing And Debugging: commands, fixtures, diagnostics, and known test risks.
• Roadmap And Risks: current gaps, priorities, and traps for maintainers.

Historical planning docs are still useful for context, but treat the files above as the current takeover documentation.

Existing historical docs:

• Progress Log
• Open Tasks
• Client Audit
• Client Implementation Plan
• Client Iteration Summary
• Backend REST/OpenAPI ADR
• Backendless Local LLM ADR
• OpenAPI Contract