Documentation Hub

Comprehensive guides for developers, administrators, and contributors.

Overview

Welcome to the QuranBot documentation center. Select a guide below to explore architecture, configuration, security protocols, and maintenance procedures.

8 Comprehensive Guides
Development & Contribution
Deployment & Scaling

Developer Guide

Project architecture, folder structure, command creation, ready handlers, and best practices for contributors.

View Guide

Configuration

Environment variables, Lavalink node setup, Redis integration, Firebase credentials, and PM2 deployment.

View Guide

Security & Contributing

Authentication architecture, permission flows, rate limiting, token handling, and pull request workflows.

View Guide

Data Pipeline

Modular loader architecture, remote CDN caching, validation layers, and formatter utilities for Quran data.

View Guide

Resources & Customization

Managing reciters, radio health checks, azkar scheduling, UI embed customization, and pagination.

View Guide

UI Architecture

Embed builders, component factories, control panel logic, message updater flow, and embed caching.

View Guide

State Management

Guild state facades, Firebase/Redis persistence, azkar automation engine, and voice idle detection.

View Guide

Maintenance & Retention

Database cleaners, 15-day retention policies, logging architecture, health checks, and backup systems.

View Guide