Skip to content

Commit de292b8

Browse files
committed
Docs Updated
1 parent 3eda244 commit de292b8

File tree

6 files changed

+58
-63
lines changed

6 files changed

+58
-63
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
- 🏆 **Professional QC**: 20+ advanced quality control categories beyond basic FFprobe
1212
- 💡 **Executive Summaries**: AI translates technical data for non-technical stakeholders
1313

14-
[![Production Ready](https://img.shields.io/badge/production-ready-green.svg)](PRODUCTION_READINESS_REPORT.md)
14+
[![Production Ready](https://img.shields.io/badge/production-ready-green.svg)](docs/PRODUCTION_READINESS_REPORT.md)
1515
[![QC Analysis](https://img.shields.io/badge/QC-20%20Categories-blue.svg)](#advanced-quality-control-features)
16-
[![Docker](https://img.shields.io/badge/docker-ready--to--deploy-blue.svg)](docker-image/QUICK_START.md)
16+
[![Docker](https://img.shields.io/badge/docker-ready--to--deploy-blue.svg)](#quick-start)
1717

1818
## 🧠 Core GenAI Differentiators
1919

@@ -53,19 +53,18 @@
5353
**🤖 The setup script automatically validates your system meets the requirements for your chosen deployment mode:**
5454

5555
```bash
56-
# 🎯 Interactive setup with automatic system validation (recommended)
57-
curl -fsSL https://raw.githubusercontent.com/rendiffdev/ffprobe-api/main/setup.sh | bash
58-
59-
# ⚡ Non-interactive modes with automatic requirements checking:
60-
curl -fsSL setup.sh | bash -s -- --quick # 3GB RAM, 8GB disk
61-
curl -fsSL setup.sh | bash -s -- --minimal # 2GB RAM, 6GB disk
62-
curl -fsSL setup.sh | bash -s -- --production # 8GB RAM, 20GB disk
63-
curl -fsSL setup.sh | bash -s -- --development # 4GB RAM, 15GB disk
64-
65-
# 🔧 Manual setup (no requirements checking)
66-
git clone https://github.com/rendiffdev/ffprobe-api.git
56+
# 🔧 Clone and setup (recommended)
57+
git clone <your-repo-url>
6758
cd ffprobe-api
6859
make quick
60+
61+
# ⚡ Alternative quick modes:
62+
make minimal # 2GB RAM, 6GB disk - core services only
63+
make dev # 4GB RAM, 15GB disk - development environment
64+
make prod # 8GB RAM, 20GB disk - production with monitoring
65+
66+
# 🎯 Interactive setup with system validation
67+
./setup.sh # Automatically detects best deployment mode
6968
```
7069

7170
**✨ What the smart installer checks:**
@@ -173,7 +172,7 @@ make prod
173172

174173
The FFprobe API provides **comprehensive professional QC analysis** with industry-standard compliance checking.
175174

176-
📋 **[Complete QC Analysis List](QC_ANALYSIS_LIST.md)** - Detailed breakdown of all 20+ QC categories
175+
📋 **[Complete QC Analysis List](docs/QC_ANALYSIS_LIST.md)** - Detailed breakdown of all 20+ QC categories
177176

178177
### QC Analysis Categories Overview
179178

@@ -538,10 +537,9 @@ docker compose exec ollama ollama pull gemma3:270m
538537

539538
## 📚 Documentation
540539

541-
- **[🚀 Quick Start (Docker)](docker-image/QUICK_START.md)** - One-command deployment
542540
- **[📖 Complete Documentation](docs/README.md)** - Full documentation index
543541
- **[📡 API Reference](docs/api/README.md)** - REST and GraphQL APIs
544-
- **[🔍 QC Features](QC_ANALYSIS_LIST.md)** - All 20+ quality control categories
542+
- **[🔍 QC Features](docs/QC_ANALYSIS_LIST.md)** - All 20+ quality control categories
545543
- **[🏢 Production Guide](docs/deployment/README.md)** - Enterprise deployment
546544
- **[🤖 AI Setup](docs/tutorials/local-llm-setup.md)** - Local AI analysis setup
547545

@@ -560,8 +558,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
560558
## 🆘 Support
561559

562560
- **Documentation**: [docs/](docs/)
563-
- **Issues**: [GitHub Issues](https://github.com/rendiffdev/ffprobe-api/issues)
564-
- **Discussions**: [GitHub Discussions](https://github.com/rendiffdev/ffprobe-api/discussions)
561+
- **Issues**: Create GitHub Issues for bug reports
562+
- **Questions**: Check documentation or create discussions
565563

566564
---
567565

docs/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Thank you for your interest in contributing to FFprobe API! This document provid
1111
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/ffprobe-api.git`
1212
3. **Add upstream**: `git remote add upstream https://github.com/rendiffdev/ffprobe-api.git`
1313
3. **Read** [Technical Guidelines](CONTRIBUTOR-GUIDELINES.md) for detailed setup instructions
14-
4. **Install** dependencies: `docker compose up -d`
14+
4. **Install** dependencies: `docker compose -f docker-image/compose.yaml up -d`
1515
5. **Run** tests: `go test ./...`
1616
6. **Start** development: `go run cmd/ffprobe-api/main.go`
1717

@@ -31,7 +31,7 @@ git clone https://github.com/rendiffdev/ffprobe-api.git
3131
cd ffprobe-api
3232

3333
# Start development environment (includes PostgreSQL, Redis, FFmpeg)
34-
docker compose -f compose.yaml -f compose.development.yaml up -d
34+
docker compose -f docker-image/compose.yaml -f docker-image/compose.development.yaml up -d
3535

3636
# Verify setup
3737
curl http://localhost:8080/health

docs/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
### 🚀 Getting Started
88
- **[Quick Start Guide](../README.md#quick-start)** - Get running in 2 minutes
9-
- **[Docker Deployment](../docker-image/QUICK_START.md)** - Zero-config Docker deployment
9+
- **[Docker Deployment](../README.md#deployment-modes)** - Zero-config Docker deployment
1010
- **[Local AI Setup](tutorials/local-llm-setup.md)** - AI-powered analysis setup
1111

1212
### 📡 API Reference
@@ -19,20 +19,20 @@
1919
- **[Production Deployment](deployment/README.md)** - Production deployment strategies
2020
- **[Architecture Overview](development/architecture.md)** - System architecture and design
2121
- **[Secret Rotation](api/SECRET_ROTATION_GUIDE.md)** - API key and JWT management
22-
- **[Complete QC Analysis List](../QC_ANALYSIS_LIST.md)** - All 20+ QC categories detailed
22+
- **[Complete QC Analysis List](QC_ANALYSIS_LIST.md)** - All 20+ QC categories detailed
2323
- **[GraphQL API Guide](api/GRAPHQL_API_GUIDE.md)** - GraphQL endpoints
2424
- **[Authentication Guide](api/authentication.md)** - API keys and security
2525
- **[Secret Rotation Guide](api/SECRET_ROTATION_GUIDE.md)** - Security management
2626

2727
### 🏗️ Development & Architecture
2828
- **[System Architecture](development/architecture.md)** - Technical design overview
29-
- **[Video Comparison System](COMPARISON_SYSTEM.md)** - Quality comparison features
29+
- **[Video Comparison System](../README.md#advanced-quality-control-features)** - Quality comparison features
3030

3131
### 🔧 Operations & Monitoring
3232
- **[FFmpeg Management](operations/ffmpeg-management.md)** - FFmpeg updates and configuration
3333
- **[Monitoring Setup](operations/monitoring.md)** - Prometheus and Grafana
3434
- **[Security Guide](operations/security.md)** - Security best practices
35-
- **[Troubleshooting](TROUBLESHOOTING.md)** - Common issues and solutions
35+
- **[Troubleshooting](../README.md#troubleshooting)** - Common issues and solutions
3636

3737
### 📋 Production Readiness
3838
- **[Production Checklist](deployment/PRODUCTION_READINESS_CHECKLIST.md)** - Pre-deployment validation
@@ -45,7 +45,7 @@
4545

4646
#### **Analyze videos**
4747
- [Upload and analyze a video file →](api/README.md)
48-
- [Compare video quality improvements →](COMPARISON_SYSTEM.md)
48+
- [Compare video quality improvements →](../README.md#genai-analysis-examples-core-usp)
4949
- [Enable AI-powered insights →](tutorials/local-llm-setup.md)
5050

5151
#### **Deploy to production**
@@ -54,14 +54,14 @@
5454
- [Monitoring setup →](operations/monitoring.md)
5555

5656
#### **Develop and extend**
57-
- [API development tutorial](tutorials/api_usage.md)
57+
- [API development guide](api/README.md)
5858
- [System architecture →](development/architecture.md)
5959
- [Contributing guidelines →](../CONTRIBUTING.md)
6060

6161
#### **Troubleshoot issues**
62-
- [Common problems and solutions →](TROUBLESHOOTING.md)
62+
- [Common problems and solutions →](../README.md#troubleshooting)
6363
- [FFmpeg issues →](operations/ffmpeg-management.md)
64-
- [Docker Compose issues](deployment/modern-docker-compose.md)
64+
- [Docker setup help](../README.md#quick-start)
6565

6666
---
6767

@@ -99,9 +99,9 @@
9999

100100
## 🆘 Support
101101

102-
- **Documentation Issues**: Check [troubleshooting guide](TROUBLESHOOTING.md)
103-
- **Bug Reports**: [GitHub Issues](https://github.com/rendiffdev/ffprobe-api/issues)
104-
- **Feature Requests**: [GitHub Discussions](https://github.com/rendiffdev/ffprobe-api/discussions)
102+
- **Documentation Issues**: Check [troubleshooting guide](../README.md#troubleshooting)
103+
- **Bug Reports**: Create GitHub Issues for bugs
104+
- **Feature Requests**: Create GitHub Issues for feature requests
105105

106106
---
107107

docs/deployment/README.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ FFprobe API supports multiple deployment strategies to meet different scales and
2222

2323
```bash
2424
# Clone repository
25-
git clone https://github.com/rendiffdev/ffprobe-api.git
25+
git clone <your-repo-url>
2626
cd ffprobe-api
2727

2828
# Start all services
29-
docker compose up -d
29+
docker compose -f docker-image/compose.yaml up -d
3030

3131
# Verify deployment
3232
curl http://localhost:8080/health
@@ -40,10 +40,10 @@ curl http://localhost:8080/health
4040

4141
```bash
4242
# Basic services only
43-
docker compose up -d
43+
docker compose -f docker-image/compose.yaml up -d
4444

4545
# Verify services
46-
docker compose ps
46+
docker compose -f docker-image/compose.yaml ps
4747
```
4848

4949
**Resources**: 4GB RAM, 2 CPU cores, 10GB storage
@@ -54,10 +54,10 @@ docker compose ps
5454

5555
```bash
5656
# Production configuration with monitoring
57-
docker compose -f compose.yml -f compose.production.yml up -d
57+
docker compose -f docker-image/compose.yaml -f docker-image/compose.production.yaml up -d
5858

5959
# Scale API instances
60-
docker compose -f compose.yml -f compose.production.yml up -d --scale ffprobe-api=2
60+
docker compose -f docker-image/compose.yaml -f docker-image/compose.production.yaml up -d --scale ffprobe-api=2
6161
```
6262

6363
**Resources**: 8GB RAM, 4 CPU cores, 50GB storage
@@ -69,10 +69,9 @@ docker compose -f compose.yml -f compose.production.yml up -d --scale ffprobe-ap
6969

7070
```bash
7171
# Enterprise deployment with full monitoring stack
72-
docker compose -f compose.yml -f compose.enterprise.yml up -d \
72+
docker compose -f docker-image/compose.yaml -f docker-image/compose.production.yaml up -d \
7373
--scale ffprobe-api=3 \
74-
--scale ffprobe-worker=5 \
75-
--scale llm-service=2
74+
--scale ollama=2
7675
```
7776

7877
**Resources**: 16GB+ RAM, 8+ CPU cores, 100GB+ storage
@@ -92,13 +91,13 @@ docker compose -f compose.yml -f compose.enterprise.yml up -d \
9291

9392
```bash
9493
# Horizontal scaling
95-
docker compose up -d --scale ffprobe-api=3
94+
docker compose -f docker-image/compose.yaml up -d --scale ffprobe-api=3
9695

9796
# Resource limits (production)
98-
docker compose -f compose.yml -f compose.production.yml up -d
97+
docker compose -f docker-image/compose.yaml -f docker-image/compose.production.yaml up -d
9998

10099
# Enterprise with monitoring
101-
docker compose -f compose.yml -f compose.enterprise.yml up -d
100+
docker compose -f docker-image/compose.yaml -f docker-image/compose.production.yaml up -d
102101
```
103102

104103
## Environment Configuration
@@ -303,10 +302,10 @@ Available at `http://localhost:8080/metrics`:
303302

304303
```bash
305304
# View application logs
306-
docker compose logs -f ffprobe-api
305+
docker compose -f docker-image/compose.yaml logs -f ffprobe-api
307306

308307
# Monitor specific service
309-
docker compose logs -f postgres
308+
docker compose -f docker-image/compose.yaml logs -f postgres
310309
```
311310

312311
## Backup and Recovery
@@ -315,10 +314,10 @@ docker compose logs -f postgres
315314

316315
```bash
317316
# Create backup
318-
docker compose exec postgres pg_dump -U postgres ffprobe_api > backup.sql
317+
docker compose -f docker-image/compose.yaml exec postgres pg_dump -U postgres ffprobe_api > backup.sql
319318

320319
# Restore backup
321-
docker compose exec -T postgres psql -U postgres ffprobe_api < backup.sql
320+
docker compose -f docker-image/compose.yaml exec -T postgres psql -U postgres ffprobe_api < backup.sql
322321
```
323322

324323
### Configuration Backup
@@ -357,10 +356,10 @@ docker compose exec postgres psql -U postgres -c "SELECT * FROM pg_stat_activity
357356

358357
```bash
359358
# Pull latest images
360-
docker compose pull
359+
docker compose -f docker-image/compose.yaml pull
361360

362361
# Restart with new version
363-
docker compose up -d
362+
docker compose -f docker-image/compose.yaml up -d
364363

365364
# Verify update
366365
curl http://localhost:8080/health
@@ -372,16 +371,14 @@ Database migrations run automatically on startup. For manual migration:
372371

373372
```bash
374373
# Run migrations manually
375-
docker compose exec ffprobe-api ./migrate -path ./migrations -database "postgres://..." up
374+
docker compose -f docker-image/compose.yaml exec ffprobe-api ./migrate -path ./migrations -database "postgres://..." up
376375
```
377376

378377
---
379378

380379
## Next Steps
381380

382-
- [Configuration Reference](configuration.md)
383-
- [Monitoring Setup](monitoring.md)
384-
- [Production Readiness Checklist](PRODUCTION_READINESS_CHECKLIST.md)
385-
- [Troubleshooting Guide](../troubleshooting/README.md)
386-
387-
*For support, see [GitHub Issues](https://github.com/rendiffdev/ffprobe-api/issues)*
381+
- [Monitoring Setup](../operations/monitoring.md)
382+
- [Security Guide](../operations/security.md)
383+
- [Production Readiness Report](../PRODUCTION_READINESS_REPORT.md)
384+
- [Troubleshooting Guide](../../README.md#troubleshooting)

docs/operations/monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -457,11 +457,11 @@ curl http://prometheus:9090/api/v1/query?query=prometheus_tsdb_symbol_table_size
457457
### Log Overflow
458458
```bash
459459
# Check log volume
460-
docker compose logs ffprobe-api | wc -l
460+
docker compose -f docker-image/compose.yaml logs ffprobe-api | wc -l
461461

462462
# Adjust log level
463463
export LOG_LEVEL=warn
464-
docker compose restart ffprobe-api
464+
docker compose -f docker-image/compose.yaml restart ffprobe-api
465465
```
466466

467467
---

docs/tutorials/local-llm-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ The FFprobe API uses an optimized dual-model AI approach:
1414

1515
### 🐳 **Fully Containerized Services**
1616
```bash
17-
docker compose up -d
17+
docker compose -f docker-image/compose.yaml up -d
1818
# That's it! Everything is configured automatically:
19-
# ✅ Ollama with Phi-3 Mini model
20-
# ✅ PostgreSQL database
21-
#Redis caching
22-
# ✅ FFmpeg/FFprobe workers
19+
# ✅ Ollama with Gemma 3 270M + Phi-3 Mini models
20+
#SQLite/PostgreSQL database
21+
#Valkey caching
22+
# ✅ FFmpeg/FFprobe integration
2323
# ✅ API server with authentication
2424
```
2525

0 commit comments

Comments
 (0)