Shrutik Documentation

Welcome to the comprehensive documentation for Shrutik (শ্রুতিক), the open-source voice data collection platform designed to help communities build high-quality voice datasets in their native languages.

Shrutik means “listener” in Bengali, reflecting our mission to listen to and preserve diverse voices from around the world.

About This Documentation

This documentation is built with mdBook and provides comprehensive guides, API references, and tutorials for users, developers, and administrators.

Enhanced Features

Interactive Mermaid Diagrams: Zoom, pan, and view complex flowcharts in fullscreen
Professional Styling: Custom theme with Shrutik branding and improved readability
Responsive Design: Optimized experience on desktop and mobile devices
Status Badges: Color-coded indicators for different content types
Enhanced Navigation: Improved sidebar, search, and user experience

Interactive Diagram Controls

Zoom: Use mouse wheel or +/- buttons to zoom in/out
Pan: Drag to move around when zoomed in
Reset: Double-click or press ‘0’ to reset view
Fullscreen: Click the fullscreen button for better viewing
Mobile: Touch-friendly controls for mobile devices

Documentation Overview

Getting Started

Getting Started Guide - Quick setup and first steps
Docker Local Setup - Complete Docker development guide
Local Development - Native development environment setup

Architecture & Design

System Architecture - Complete system design overview
API Reference - Comprehensive API documentation
Flowcharts - Visual system flow documentation

Contributing

Contributing Guide - How to contribute to Shrutik
Code of Conduct - Community guidelines

Additional Resources

Audio Processing Modes - Audio processing capabilities
Troubleshooting - Common issues and solutions
FAQ - Frequently asked questions

For New Users

Getting Started - Set up Shrutik in minutes
Docker Local Setup - Run everything with Docker
User Guide - Learn how to contribute voice data

For Developers

Docker Local Setup - Quick Docker development setup
Local Development - Native development environment
Architecture Overview - Understand the system design
API Reference - Integrate with Shrutik APIs
Contributing Guide - Contribute code and features

For System Administrators

Docker Local Setup - Deploy with Docker
Deployment Guide - Production deployment strategies
Monitoring & Health Checks - System monitoring

For Researchers & Data Scientists

API Reference - Export datasets
Architecture - Understand data structure
Quality Control - Data quality processes

Visual Documentation

System Flows

System Architecture - High-level system overview
Voice Recording Flow - Complete recording process
Transcription Workflow - Transcription and consensus

Technical Diagrams

API Request Flow - API request lifecycle
Database Operations - Data flow patterns
Caching Strategy - Performance optimization

Development Resources

Setup & Configuration

Environment Setup - Development environment
Configuration Guide - Environment variables
Testing Guide - Testing strategies

Code Standards

Coding Standards - Code style guidelines
API Design - RESTful API principles
Database Design - Schema and patterns

Deployment Options

Option	Complexity	Use Case	Documentation
Docker Compose	Low	Development, Small Teams	Docker Deployment
Kubernetes	High	Production, Enterprise	Deployment Guide
Cloud Platforms	Medium	Managed Services	Deployment Guide
Bare Metal	Medium	On-Premises	Deployment Guide