Proximity Documentation Index
Documentation Map
Getting Started
| Document | Purpose |
|---|---|
| Installation Guide | Setup instructions |
| First Steps | Your first deployment walkthrough |
| Quick Start | Quick setup with Docker Compose |
Architecture & Design
| Document | Purpose |
|---|---|
| Architecture | System design & component relationships |
API Documentation
| Document | Purpose |
|---|---|
| REST API | Endpoint reference with examples |
Development
| Document | Purpose |
|---|---|
| Testing Guide | Running & writing tests |
| Contributing | Contribution guidelines |
Security
| Document | Purpose |
|---|---|
| Security Summary | Security audit findings and fixes |
| Backend Security Audit | Backend security findings |
| Frontend Security Audit | Frontend security findings |
Quick Navigation
- New user: Installation → First Steps
- Developer: Architecture → Testing → Contributing
- API user: REST API
- Security: Security Summary → audit reports in
security/