OpenKeep Documentation

This directory is the main documentation hub for the current state of OpenKeep.

Documentation Sets

User Documentation

Start here if you are using OpenKeep to manage your archive.

• Getting Started
• Core Workflows
• Search and AI
• Review and Corrections
• Settings and Admin
• Desktop App
• Mobile App
• FAQ

Technical Documentation

Start here if you are contributing to or extending OpenKeep.

• Technical Overview
• Architecture Overview
• API and Data Flows
• Agentic Document Intelligence
• Web Application
• Desktop Application
• Testing and Validation

Supporting reference material:

• Backend Notes
• UI Visualization Plan

Operational Documentation

Start here if you are deploying or operating OpenKeep.

• Operations Overview
• Deployment Guide
• iOS Releases
• Cloudflare Pages and Oracle Typesense
• Configuration Reference
• Runbooks
• Backup, Restore, and Portability
• Monitoring and Health

Supporting reference material:

• Manual Smoke Checklist

Recommended Reading Order

If you are using OpenKeep

1. Getting Started
2. Core Workflows
3. Search and AI
4. Review and Corrections
5. Settings and Admin
6. Desktop App
7. Mobile App
8. FAQ

If you are building OpenKeep

1. Technical Overview
2. Architecture Overview
3. API and Data Flows
4. Agentic Document Intelligence
5. Web Application
6. Desktop Application
7. Testing and Validation

If you are operating OpenKeep

1. Operations Overview
2. Deployment Guide
3. Cloudflare Pages and Oracle Typesense
4. Configuration Reference
5. Runbooks
6. Backup, Restore, and Portability
7. Monitoring and Health