📚 CrawlLama Documentation Overview

Welcome to the CrawlLama documentation! This guide organizes all tutorials, references, and guides into clear categories for easier navigation.

📋 Categories

🚀 Getting Started

First steps with CrawlLama:

• INSTALLATION.md – Detailed installation guide
• QUICKSTART.md – Quick start in 5 minutes
• CONFIG_SETUP.md – Configuration file setup and usage
• ADAPTIVE_HOPS_QUICKSTART.md – Adaptive Hops quick start

📖 Guides & Tutorials

Feature-specific guides:

• LANGGRAPH_GUIDE.md – Multi-hop reasoning with LangGraph
• PLUGIN_TUTORIAL.md – Developing and using plugins
• SEARCH_LIMITATIONS.md – Web search limitations
• HALLUCINATION_DETECTION.md – Hallucination detection
• RAG_ANALYSIS.md – RAG implementation and architecture
• API_USAGE.md – API usage guide

🔍 OSINT Features

Open Source Intelligence Module:

• OSINT_USAGE.md – OSINT modules (Email, Phone, Advanced Operators)
• PHONE_INTELLIGENCE.md – Phone intelligence developer documentation (parsing, normalization, auto-detection)
• OSINT_CONTEXT_USAGE.md – OSINT in context
• SOCIAL_INTELLIGENCE.md – Social intelligence features

🏥 Health Monitoring

System monitoring and dashboard:

• HEALTH_MONITORING.md – Health monitoring
• HEALTH_DASHBOARD.md – Dashboard usage
• HEALTH_FEATURES.md – Available features
• DASHBOARD_STARTER.md – Starting the dashboard

🤖 Adaptive Agent Hopping

• ADAPTIVE_HOPS.md – Intelligent agent selection and complexity management

🔧 Development

• PROJECT_STRUCTURE.md – Project structure overview
• bugs/delete_null_file.md – Bug examples

🔒 Security

• SECRET_LEAK_RESPONSE.md – Secret leak response and incident plan

👥 Community & Contributing

• README.md – Main project documentation
• CONTRIBUTING.md – How to contribute
• CODE_OF_CONDUCT.md – Community code of conduct
• SECURITY.md – Report vulnerabilities
• CHANGELOG.md – Release history

🗂️ Directory Structure

docs/
├── README.md
├── getting-started/
│   ├── INSTALLATION.md
│   └── QUICKSTART.md
├── guides/
│   ├── LANGGRAPH_GUIDE.md
│   ├── PLUGIN_TUTORIAL.md
│   ├── SEARCH_LIMITATIONS.md
│   ├── HALLUCINATION_DETECTION.md
│   └── RAG_ANALYSIS.md
├── osint/
│   ├── OSINT_USAGE.md
│   ├── PHONE_INTELLIGENCE.md
│   ├── OSINT_CONTEXT_USAGE.md
│   └── SOCIAL_INTELLIGENCE.md
├── health/
│   ├── HEALTH_MONITORING.md
│   ├── HEALTH_DASHBOARD.md
│   ├── HEALTH_FEATURES.md
│   └── DASHBOARD_STARTER.md
├── development/
│   ├── PROJECT_STRUCTURE.md
│   ├── RELEASE_PROCESS.md
│   ├── PRE_RELEASE_CHECK.md
│   └── bugs/
│       └── delete_null_file.md
└── security/
└── SECRET_LEAK_RESPONSE.md

Root Project Files

• config.json – Main configuration
• .env.example – Environment variables template
• pytest.ini – Test configuration

🔗 External Links

• GitHub Repository: github.com/arn-c0de/Crawllama
• Issues: github.com/arn-c0de/Crawllama/issues
• Security Advisories: github.com/arn-c0de/Crawllama/security

📑 Recommended Learning Path

1. Getting Started 🚀

1. README.md – Project overview
2. INSTALLATION.md – Detailed installation
3. QUICKSTART.md – Quick start

2. Using Core Features 📖

1. LANGGRAPH_GUIDE.md – Multi-hop reasoning
2. PLUGIN_TUTORIAL.md – Plugin system
3. HEALTH_MONITORING.md – Health dashboard

3. Advanced Features 🔍

1. OSINT_USAGE.md – OSINT features
2. PHONE_INTELLIGENCE.md – Phone intelligence internals
3. HALLUCINATION_DETECTION.md – Quality control
4. SEARCH_LIMITATIONS.md – Search limitations

4. Development & Security 🔧

1. CONTRIBUTING.md – Contribution guidelines
2. RELEASE_PROCESS.md – Release workflow
3. SECRET_LEAK_RESPONSE.md – Incident response

🆘 Need Help?

• Found a bug? → Bug Report
• Feature request? → Feature Request
• Documentation issue? → Documentation Issue