Version: 0.9.1 Last Updated: February 9, 2026 Total Documentation Files: 581 markdown files

---

New to nself-chat? Start with these documents:

1. 📚 Home - Main documentation hub with organized navigation
2. 🚀 Quick Start - Get running in 5 minutes
3. 📦 Installation Guide - Detailed setup instructions
4. 👤 User Guide - Complete end-user documentation

• Quick Start
• Getting Started Tutorial
• User Guide
• FAQ

• Configuration Guide
• Feature Documentation
• Deployment Guide
• API Overview

• Architecture Deep Dive
• API Documentation
• Plugin Development
• Bot Development

---

Location: docs/getting-started/

Essential first steps for new users:

• QUICK-START.md - 5-minute setup guide
• Installation.md - Detailed installation
• Getting-Started.md - First steps tutorial
• README.md - Section overview

Location: docs/features/

Complete feature documentation:

• Features.md - Complete feature list (150+ features)
• Features-Messaging.md - Chat capabilities
• Features-Complete.md - Feature parity matrix

• VOICE-CALLING-COMPLETE.md - Voice calls
• LIVE_STREAMING_IMPLEMENTATION_SUMMARY.md - Live streaming
• SCREEN-SHARING-SUMMARY.md - Screen sharing
• MOBILE-CALLS-IMPLEMENTATION.md - Mobile optimization

• GIF-Sticker-Implementation.md - GIFs and stickers
• Polls-Implementation.md - Interactive polls
• Social-Media-Integration.md - Social platforms

• E2EE-Complete.md - End-to-end encryption
• SEARCH_IMPLEMENTATION_SUMMARY.md - MeiliSearch integration

• White-Label-Guide.md - Complete branding guide
• Bots.md - Bot development SDK
• Plugins.md - Plugin system
• Plugins-List.md - Available plugins

Location: docs/guides/

Step-by-step implementation and usage guides:

• USER-GUIDE.md - Complete user documentation
• Settings-Quick-Start.md - Settings configuration

• advanced-messaging-implementation-summary.md - Message features
• E2EE-Implementation.md - Encryption setup
• Search-Implementation.md - Search integration
• Call-Management-Guide.md - Call system
• testing-guide.md - Testing strategies
• internationalization.md - i18n setup

• enterprise/README.md - Enterprise overview
• enterprise/SSO-Setup.md - Single sign-on
• enterprise/RBAC-Guide.md - Access control
• enterprise/Audit-Logging.md - Compliance

• deployment/DEPLOYMENT-CHECKLIST.md - Pre-deploy checklist
• deployment/DEPLOYMENT.md - Deployment overview

Location: docs/configuration/

Configuration and setup:

• Configuration.md - Complete reference
• Authentication.md - Auth providers (11 options)
• Environment-Variables.md - All env vars
• README.md - Configuration overview

Location: docs/api/

GraphQL API reference:

• API.md - Getting started
• API-DOCUMENTATION.md - Complete reference
• API-EXAMPLES.md - Multi-language examples
• BOT_API_IMPLEMENTATION.md - Bot API
• authentication.md - Auth endpoints
• graphql-schema.md - Full schema
• README.md - API overview

Location: docs/deployment/

Production deployment guides:

• DEPLOYMENT.md - Main deployment guide
• Deployment-Docker.md - Docker deployment
• Deployment-Kubernetes.md - Kubernetes
• Deployment-Helm.md - Helm charts
• Production-Deployment-Checklist.md - Pre-deploy
• Production-Validation.md - Post-deploy
• Multi-Tenant-Deployment.md - Multi-tenancy
• README.md - Deployment overview

• ios-deployment.md - iOS deployment
• android-deployment.md - Android deployment
• desktop-deployment.md - Desktop apps

Location: docs/reference/

Technical reference documentation:

• Architecture.md - System design
• ARCHITECTURE-DIAGRAMS.md - Visual docs
• Database-Schema.md - Database structure
• Project-Structure.md - Codebase organization
• Types.md - TypeScript types
• SPORT.md - Complete API reference

• 2FA-Quick-Reference.md
• advanced-messaging-quick-reference.md
• Call-Management-Quick-Reference.md
• E2EE-Quick-Reference.md
• Live-Streaming-Quick-Start.md
• Mobile-Calls-Quick-Reference.md
• PIN-LOCK-QUICK-START.md
• Polls-Quick-Start.md
• Screen-Sharing-Quick-Reference.md
• Search-Quick-Start.md
• Social-Media-Quick-Reference.md
• Voice-Calling-Quick-Start.md

Location: docs/security/

Security features and best practices:

• SECURITY.md - Security architecture
• SECURITY-AUDIT.md - Audit results
• PERFORMANCE-OPTIMIZATION.md - Performance

• 2FA-Implementation-Summary.md - Two-factor auth
• PIN-LOCK-SYSTEM.md - PIN lock + biometrics
• PIN-LOCK-IMPLEMENTATION-SUMMARY.md - Technical details

• E2EE-Implementation-Summary.md - E2E encryption
• E2EE-Security-Audit.md - Encryption audit

• ANTI-CENSORSHIP.md - Anti-censorship measures
• DATA-FLOW.md - Data flow diagrams
• SECURITY-CONTROLS.md - Security controls
• THREAT-MODEL.md - Threat analysis

Location: docs/troubleshooting/

Common issues and solutions:

• FAQ.md - Frequently asked questions
• TROUBLESHOOTING.md - Common issues
• RUNBOOK.md - Operations guide

Location: docs/about/

Project information:

• Changelog.md - Version history
• RELEASE-NOTES-v0.3.0.md - Latest release
• IMPLEMENTATION_COMPLETE.md - Completion status

• Roadmap.md - Future plans
• UPGRADE-GUIDE.md - Version upgrades
• Contributing.md - How to contribute

• DOCUMENTATION-AUDIT.md - Quality assessment
• DOCUMENTATION-MAP.md - Structure overview

Location: docs/compliance/

Compliance and legal:

• COMPLIANCE-OVERVIEW.md - Compliance guide
• README.md - Compliance overview

Location: docs/releases/

Version-specific documentation:

• v0.9.1/MISSION-ACCOMPLISHED.md
• v0.9.1/reports/V0.9.1-QUALITY-REPORT.md
• v0.9.1/reports/V0.9.1-COMPLETION-REPORT.md

• v0.9.0/RELEASE-NOTES.md

Location: docs/archive/

Historical documentation:

• DOCUMENTATION-STATUS.md
• FEATURE-PARITY-REPORT.md
• TESTING-SUMMARY.md

---

1. Quick Start - 5 minutes
2. Installation Guide - Detailed setup
3. Configuration Guide - Configure
4. User Guide - Learn features

1. Production Checklist - Pre-deploy
2. Deployment Guide - Main guide
3. Docker Deployment or Kubernetes
4. Production Validation - Post-deploy
5. Runbook - Operations

1. Features Overview - Browse features
2. Find specific feature guide (e.g., E2EE Implementation)
3. Check API Documentation for endpoints
4. Review Testing Guide for tests
5. Check Quick Reference for shortcuts

1. FAQ - Common questions
2. Troubleshooting Guide - Common issues
3. Runbook - Ops procedures
4. GitHub Issues - Report bugs

1. Bot Development - Bot SDK
2. Bot API - API reference
3. Plugin Development - Plugin system
4. API Examples - Code samples

1. Architecture Overview - System design
2. Architecture Diagrams - Visual docs
3. Database Schema - Database structure
4. Project Structure - Code organization

---

Category	Files	Description
Getting Started	6	First steps and installation
Features	60+	Feature documentation
Guides	70+	Implementation guides
Configuration	10+	Configuration reference
API	30+	API documentation
Deployment	40+	Deployment guides
Reference	100+	Technical reference
Security	30+	Security docs
Troubleshooting	15+	Issue resolution
About	30+	Project information
Compliance	10+	Legal/compliance
Releases	50+	Version-specific
Archive	50+	Historical docs
Plugins	10+	Plugin documentation
Other	70+	Miscellaneous
Total	581	All documentation

---

1. Use the sidebar in GitHub Wiki for quick navigation
2. Search by filename using GitHub's file finder (press t in repo)
3. Search content using GitHub's search (press / in repo)
4. Browse by category using this index

• Setup: QUICK-START.md, Installation.md, Getting-Started.md
• Features: Features.md, Features-Messaging.md, White-Label-Guide.md
• Deployment: DEPLOYMENT.md, Production-Deployment-Checklist.md
• API: API-DOCUMENTATION.md, API-EXAMPLES.md, graphql-schema.md
• Security: SECURITY.md, E2EE-Implementation-Summary.md, 2FA-Implementation-Summary.md
• Troubleshooting: FAQ.md, TROUBLESHOOTING.md, RUNBOOK.md

---

All documentation in this project follows these standards:

1. Markdown Format: All docs are .md files
2. Clear Headings: Hierarchical structure with H1-H6
3. Code Examples: Syntax-highlighted code blocks
4. Links: Relative links to other docs
5. Images: Stored in appropriate directories
6. Version Info: Documents include version numbers where relevant
7. Last Updated: Key documents show last update date

---

See Contributing Guide for:

• Documentation style guide
• How to add new docs
• Review process
• Quality standards

---

• GitHub Issues: Bug reports & feature requests
• Discussions: GitHub Discussions
• Email: [email protected]

---

• Current Version: 0.9.1
• Release Date: February 3, 2026
• Index Last Updated: February 9, 2026
• Next Version: 1.0.0 (Planned)

---