Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
232 lines (170 loc) · 8.84 KB

DOCUMENTATION_INDEX.md

File metadata and controls

232 lines (170 loc) · 8.84 KB

DAFU - Complete Documentation Index

🎯 Overview

This is the master index for all DAFU platform documentation. Use this guide to navigate to the right documentation for your needs.

⭐ Start Here

Complete Usage Guide

The single most important document - covers all DAFU features in one place:

  • Quick start (3 steps)
  • All CLI commands
  • Complete workflow examples
  • Troubleshooting
  • Configuration

Start here if you're new to DAFU!

📚 Documentation by Category

🔐 API & Backend

Location: core/docs/api/

Document Purpose Audience
API Usage Guide Complete REST API reference Developers
API Quick Start 5-minute API setup Everyone
API README API documentation index Everyone
Postman Collection Ready-to-use API tests Developers

Covers: Authentication, Logs, Reports, Products endpoints

Tools:

💻 CLI & Interface

Location: core/docs/cli/

Document Purpose Audience
DAFU CLI Guide Original CLI reference CLI users
CLI Demo Usage examples Everyone
CLI Integration API integration details Developers
CLI Step-by-Step Authentication flow New users
CLI Usage Complete Complete CLI reference Power users
CLI README CLI documentation index Everyone

Covers: Unified CLI with auth, logs, reports, products, ML models

📘 Getting Started Guides

Location: core/docs/guides/

Document Purpose Audience
Quick Start ML models quick start Data scientists

Covers: ML model training and usage

🐳 Deployment & Infrastructure

Location: core/docs/docker/

Document Purpose Audience
Docker Status Current deployment status DevOps
Docker Setup Docker configuration DevOps
Docker README Docker overview Everyone

Covers: Docker Compose, containerization, deployment

📖 Root Documentation

Location: / (project root)

Document Purpose
README.md Main project README
USAGE_GUIDE Complete usage guide
DOCUMENTATION_INDEX Documentation index

🎯 Quick Navigation by Task

I want to...

Task Documentation
Get started with everything Usage Guide
Use the CLI CLI Guide
Setup the API API Quick Start
Call API endpoints API Usage Guide
Test API with Postman Postman Collection
Run ML models ML Quick Start
Deploy with Docker Docker Status
Authenticate users CLI Step-by-Step
View logs Usage Guide - Logs
Create reports Usage Guide - Reports
Manage products Usage Guide - Products
Customer analytics Usage Guide - Customer Analytics

📊 Documentation Organization

dafu/
├── README.md                           # Main project README
├── DAFU_API.postman_collection.json    # 📦 Postman API collection
├── core/
│   ├── docs/
│   │   ├── USAGE_GUIDE.md              # ⭐ Complete usage guide (START HERE)
│   │   ├── README.md                   # Documentation index
│   │   ├── api/                        # 🔐 API Documentation
│   │   │   ├── README.md
│   │   │   ├── API_USAGE_GUIDE.md      # Complete API reference
│   │   │   └── QUICK_START_API.md      # 5-minute API setup
│   │   ├── cli/                        # 💻 CLI Documentation
│   │   │   ├── README.md
│   │   │   ├── DAFU_CLI_GUIDE.md       # Original CLI guide
│   │   │   ├── DAFU_CLI_DEMO.md        # Usage examples
│   │   │   ├── DAFU_CLI_INTEGRATED.md  # API integration
│   │   │   ├── CLI_STEP_BY_STEP.md     # Step-by-step auth
│   │   │   └── CLI_USAGE_COMPLETE.md   # Complete reference
│   │   ├── guides/                     # 📘 Getting Started
│   │   │   ├── QUICK_START.md          # ML models quick start
│   │   │   └── IMPLEMENTATION_COMPLETE.md
│   │   ├── docker/                     # 🐳 Docker Documentation
│   │   │   ├── DOCKER_STATUS.md
│   │   │   ├── DOCKER_SETUP.md
│   │   │   └── DOCKER_README.md
│   │   └── assets/                     # 🖼️ Images & Diagrams
│   │       └── High-level-architecture.drawio.png
│   │
│   └── features/
│       └── fraud_detection/
│           ├── API_README.md           # API overview
│           ├── USAGE_EXAMPLES.md       # Usage examples
│           └── cli_login.sh            # Login helper script

🚀 Quick Start Paths

Path 1: Complete Platform (Recommended)

  1. Usage Guide - Complete overview
  2. API Quick Start - Setup API
  3. CLI Integration - Use CLI with API

Path 2: CLI Only

  1. DAFU CLI Guide - Learn CLI basics
  2. CLI Demo - See examples
  3. ML Quick Start - Run ML models

Path 3: API Only

  1. API Quick Start - Setup in 5 minutes
  2. API Usage Guide - Full API reference
  3. Use Swagger UI: http://localhost:8000/docs

🎓 By Experience Level

Beginners

Intermediate

Advanced

🔍 Find Documentation

By Feature

Feature Documentation
Authentication CLI Step-by-Step, API Guide
Logging Usage Guide - Logs
Reports Usage Guide - Reports
Products Usage Guide - Products
Customer Analytics Usage Guide - Customer Analytics
ML Models ML Quick Start
Docker Docker Status

By User Type

User Type Start Here
End User Usage Guide
Developer API Usage Guide
Data Scientist ML Quick Start
DevOps Docker Status
Admin Usage Guide + API Guide

📞 Support

DAFU - Enterprise Fraud Detection Platform 🚀