# du.pe Documentation Index

## 📚 Complete Documentation Set

Welcome to the comprehensive documentation for **du.pe** - a self-hosted torrent-based file manager and media player. This documentation provides everything you need to understand, deploy, and develop the application.

## 🚀 Quick Start

### **New Users**
1. [README.md](../Readme.md) - Project overview and setup instructions
2. [Quick Start Guide](./quick-start.md) - Step-by-step installation
3. [User Guide](./user-guide.md) - How to use the application

### **Developers**
1. [Project Structure](./project-structure.md) - Architecture overview
2. [API Documentation](./api-documentation.md) - Complete API reference
3. [Development Guide](./development-guide.md) - Setup and coding guidelines

### **System Administrators**
1. [Deployment Guide](./deployment-guide.md) - Production deployment
2. [Configuration Guide](./configuration.md) - Environment setup
3. [Monitoring & Maintenance](./maintenance.md) - System management

---

## 📖 Documentation Sections

### **🏗️ Architecture & Structure**
- **[Project Structure](./project-structure.md)** - Complete directory structure and component overview
- **[System Architecture](./architecture.md)** - High-level system design and data flow
- **[Component Documentation](./components.md)** - Frontend component details and usage
- **[Database Schema](./database.md)** - Data models and relationships

### **🔌 API & Integration**
- **[API Documentation](./api-documentation.md)** - Complete REST API reference
- **[WebSocket Events](./websocket-events.md)** - Real-time event documentation
- **[Integration Guide](./integration.md)** - Third-party service integration
- **[Authentication](./authentication.md)** - Security and authentication details

### **🛠️ Development**
- **[Development Guide](./development-guide.md)** - Setup, coding standards, and workflows
- **[Testing Guide](./testing.md)** - Unit, integration, and E2E testing
- **[Code Style Guide](./code-style.md)** - Coding standards and best practices
- **[Contributing Guidelines](./contributing.md)** - How to contribute to the project

### **🚀 Deployment & Operations**
- **[Deployment Guide](./deployment-guide.md)** - Production deployment instructions
- **[Docker Guide](./docker.md)** - Container deployment and management
- **[Configuration Guide](./configuration.md)** - Environment variables and settings
- **[Monitoring & Maintenance](./maintenance.md)** - System monitoring and upkeep

### **📚 User Documentation**
- **[User Guide](./user-guide.md)** - Complete user manual
- **[Feature Guide](./features.md)** - Detailed feature documentation
- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions
- **[FAQ](./faq.md)** - Frequently asked questions

### **🔒 Security & Performance**
- **[Security Guide](./security.md)** - Security best practices and guidelines
- **[Performance Guide](./performance.md)** - Optimization techniques
- **[Backup & Recovery](./backup.md)** - Data protection strategies

---

## 🎯 Navigation by Use Case

### **I want to set up du.pe for the first time**
1. [README.md](../Readme.md) - Overview and requirements
2. [Quick Start Guide](./quick-start.md) - Step-by-step installation
3. [Configuration Guide](./configuration.md) - Initial setup
4. [User Guide](./user-guide.md) - Learn the basics

### **I want to develop new features**
1. [Development Guide](./development-guide.md) - Setup and coding guidelines
2. [Project Structure](./project-structure.md) - Understand the codebase
3. [API Documentation](./api-documentation.md) - Backend integration
4. [Component Documentation](./components.md) - Frontend development
5. [Testing Guide](./testing.md) - Quality assurance

### **I want to deploy in production**
1. [Deployment Guide](./deployment-guide.md) - Production setup
2. [Docker Guide](./docker.md) - Container deployment
3. [Configuration Guide](./configuration.md) - Environment configuration
4. [Security Guide](./security.md) - Hardening the deployment
5. [Monitoring & Maintenance](./maintenance.md) - Ongoing management

### **I want to integrate du.pe with other services**
1. [API Documentation](./api-documentation.md) - REST API reference
2. [WebSocket Events](./websocket-events.md) - Real-time integration
3. [Integration Guide](./integration.md)] - Third-party service integration
4. [Authentication](./authentication.md) - Secure API access

### **I need help with a problem**
1. [Troubleshooting](./troubleshooting.md) - Common issues and solutions
2. [FAQ](./faq.md) - Frequently asked questions
3. [API Documentation](./api-documentation.md) - API reference for debugging
4. [User Guide](./user-guide.md) - Usage instructions

---

## 📋 Quick Reference Cards

### **API Quick Reference**
```bash
# Main endpoints
GET    /api/torrents           # List torrents
POST   /api/transfer           # Add torrent file
POST   /api/magnet             # Add magnet link
GET    /api/movies             # Movie library
GET    /api/tvshows            # TV shows library
GET    /api/files              # File browser
GET    /api/system/info        # System information

# Streaming
GET    /stream/:hash/:index    # Stream media file

# WebSocket
WS     ws://host:3001/?token   # Real-time events
```

### **Configuration Quick Reference**
```bash
# Environment variables
USERNAME=admin                 # Basic auth username
PASSWORD=secure_password       # Basic auth password
TMDB_API_KEY=your_key         # Movie metadata
TVDB_API_KEY=your_key         # TV show metadata
PORT=3001                     # Server port
```

### **Directory Structure**
```
dupe/
├── client/           # Frontend (Svelte)
├── server/           # Backend (Node.js)
├── downloads/        # Downloaded files
├── cache/           # Cached data
└── trash/           # Deleted items
```

### **Docker Commands**
```bash
# Start application
docker compose up -d

# View logs
docker compose logs -f

# Stop application
docker compose down

# Rebuild
docker compose up -d --build
```

---

## 🔗 External Resources

### **Technology Documentation**
- [Svelte Documentation](https://svelte.dev/docs) - Frontend framework
- [Express.js Documentation](https://expressjs.com/) - Backend framework
- [WebTorrent Documentation](https://webtorrent.io/docs) - Torrent engine
- [Node.js Documentation](https://nodejs.org/docs) - Runtime environment
- [Docker Documentation](https://docs.docker.com/) - Container platform

### **APIs and Services**
- [The Movie Database (TMDB) API](https://developers.themoviedb.org/3) - Movie metadata
- [The TV Database (TVDB) API](https://thetvdb.com/api) - TV show metadata
- [Fanart.tv API](https://fanart.tv/api-docs) - Media artwork

### **Development Tools**
- [Vite Documentation](https://vitejs.dev/) - Build tool
- [WebSocket API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) - Real-time communication
- [MDN Web Docs](https://developer.mozilla.org/) - Web standards

---

## 📝 Documentation Standards

### **Contribution Guidelines**
- Documentation should be clear, concise, and accurate
- Include code examples and practical use cases
- Maintain consistency across all documentation files
- Use proper markdown formatting and structure
- Keep documentation up to date with code changes

### **Documentation Structure**
Each documentation file should include:
- Clear title and description
- Overview section explaining the purpose
- Detailed sections with examples
- Cross-references to related documentation
- Quick reference cards when applicable

### **Version Control**
- Documentation version should match application version
- Major changes should be reflected in documentation
- Maintain changelog for both code and documentation
- Use semantic versioning for releases

---

## 🔄 Documentation Updates

### **Last Updated**: 2024-01-15
### **Documentation Version**: 1.2.0
### **Application Version**: 1.2.0

### **Recent Changes**
- Added comprehensive API documentation
- Enhanced project structure documentation
- Added development and deployment guides
- Improved cross-referencing between documents

### **Planned Documentation Updates**
- Complete user guide with screenshots
- Advanced troubleshooting guide
- Performance optimization guide
- Security hardening checklist

---

## 📞 Support & Community

### **Getting Help**
- **GitHub Issues**: Report bugs and request features
- **Documentation Issues**: Report documentation problems
- **Discussions**: Community support and discussions
- **Wiki**: Additional community-contributed content

### **Contributing**
We welcome contributions to both code and documentation! Please see the [Contributing Guidelines](./contributing.md) for details on how to get started.

---

*This index serves as the central navigation point for all du.pe documentation. Each section is cross-referenced and provides comprehensive coverage of the application from user, developer, and system administrator perspectives.*