---
title: Sentinel Scam Honeypo
emoji: 👁
colorFrom: blue
colorTo: blue
sdk: docker
pinned: false
license: mit
short_description: AI Scam Honeypot - Detect & Extract Intelligence
---

# 📚 Sentinel Project Documentation

Welcome to the comprehensive documentation suite for the **Sentinel Scam Honeypot**. This folder contains detailed architectural, operational, and compliance documents.

## 🌟 Quick Start
For a complete overview of the system's capabilities, APIs, and secrets, start here:
👉 **[Master API & Secret Catalog](MASTER_API_CATALOG.md)**

## 📂 Documentation Structure

### 🏆 GUVI Submission Pack (New)
*Mandatory documents for hackathon evaluation.*
- **[Submission Checklist](CHECKLIST.md)**: Final verification before submitting.
- **[Architecture Overview](ARCHITECTURE.md)**: Detailed system design and OODA loop.
- **[GUVI Compliance Report](GUVI_COMPLIANCE_REPORT.md)**: Traceability matrix for all requirements.
- **[API Specification](API_SPEC.md)**: Technical specs for `/api/guvi/analyze`.
- **[Technical Whitepaper](TECHNICAL_WHITEPAPER.md)**: Methodologies and innovations.
- **[Security & Ethics](SECURITY_ETHICS.md)**: Privacy and safety guardrails.
- **[Deployment Guide](DEPLOYMENT_GUIDE.md)**: Installation and scaling instructions.
- **[Limitations & Future Work](LIMITATIONS_AND_FUTURE_WORK.md)**: Real vs. Simulated disclosures.

### 🏗️ Architecture & Logic
- **[Architecture Overview](ARCHITECTURE.md)**: High-level system design.
- **[Intelligence Pipeline](INTELLIGENCE_PIPELINE.md)**: How the AI processes and detects scams.
- **[Agentic Flow](AGENTIC_FLOW.md)**: Decision-making logic of the autonomous agents.
- **[Model Switching](MODEL_SWITCHING.md)**: Adaptation between Groq and other providers.

### 🛡️ Compliance & Ethics
- **[GUVI Compliance](GUVI_COMPLIANCE.md)**: Legacy compliance reference.
- **[Ethics & Safety](ETHICS_COMPLIANCE.md)**: Detailed safety guardrails.
- **[Security Standards](SECURITY_ETHICS.md)**: Data protection protocols.

### 🚀 Deployment & Operations
- **[Deployment Guide (Legacy)](DEPLOYMENT.md)**: Original deployment steps.
- **[API Reference](API_REFERENCE.md)**: Detailed endpoint documentation.
- **[Master API & Secret Catalog](MASTER_API_CATALOG.md)**: Exhaustive endpoint list.
- **[Demo Script](DEMO_SCRIPT.md)**: Script for live demonstrations.

### 🔍 Audits
- **[Final Pre-Deploy Audit](FINAL_PRE_DEPLOY_AUDIT.md)**: Verification checklist.
- **[Research References](RESEARCH_REFERENCES.md)**: Academic and technical sources.

---
*Maintained by the Sentinel Dev Team.*