Munich-news/docs/INDEX.md

Documentation Index

Quick Start

• README - Project overview and quick start
• QUICKSTART - Detailed 5-minute setup guide

Setup & Configuration

• OLLAMA_SETUP - Ollama AI service setup
• GPU_SETUP - GPU acceleration setup (5-10x faster)
• DEPLOYMENT - Production deployment guide

API Documentation

• ADMIN_API - Admin endpoints (crawl, send newsletter)
• API - Public API endpoints
• SUBSCRIBER_STATUS - Subscriber status system

Architecture & Design

• SYSTEM_ARCHITECTURE - Complete system architecture
• ARCHITECTURE - High-level architecture overview
• DATABASE_SCHEMA - MongoDB schema and connection
• BACKEND_STRUCTURE - Backend code structure

Features & How-To

• CRAWLER_HOW_IT_WORKS - News crawler explained
• EXTRACTION_STRATEGIES - Content extraction
• RSS_URL_EXTRACTION - RSS feed handling
• PERFORMANCE_COMPARISON - CPU vs GPU benchmarks

Security

• SECURITY_NOTES - Complete security guide
  • Network isolation
  • MongoDB security
  • Ollama security
  • Best practices

Reference

• CHANGELOG - Version history and recent updates
• QUICK_REFERENCE - Command cheat sheet

Contributing

• CONTRIBUTING - How to contribute

---

Documentation Organization

Root Level (3 files)

Essential files that should be immediately visible:

• README.md - Main entry point
• QUICKSTART.md - Quick setup guide
• CONTRIBUTING.md - Contribution guidelines

docs/ Directory (18 files)

All technical documentation organized by category:

• Setup: Ollama, GPU, Deployment
• API: Admin API, Public API, Subscriber system
• Architecture: System design, database, backend structure
• Features: Crawler, extraction, RSS handling
• Security: Complete security documentation
• Reference: Changelog, quick reference

---

Quick Links by Task

I want to...

Set up the project:

1. README - Overview
2. QUICKSTART - Step-by-step setup

Enable GPU acceleration:

1. GPU_SETUP - Complete GPU guide
2. Run: ./start-with-gpu.sh

Send newsletters:

1. ADMIN_API - API documentation
2. SUBSCRIBER_STATUS - Subscriber system

Understand the architecture:

1. SYSTEM_ARCHITECTURE - Complete overview
2. DATABASE_SCHEMA - Database design

Secure my deployment:

1. SECURITY_NOTES - Security guide
2. DEPLOYMENT - Production deployment

Troubleshoot issues:

1. QUICK_REFERENCE - Common commands
2. OLLAMA_SETUP - Ollama troubleshooting
3. GPU_SETUP - GPU troubleshooting

---

Documentation Standards

File Naming

• Use UPPERCASE for main docs (README, QUICKSTART)
• Use Title_Case for technical docs (GPU_Setup, API_Reference)
• Use descriptive names (not DOC1, DOC2)

Organization

• Root level: Only essential user-facing docs
• docs/: All technical documentation
• Keep related content together

Content

• Start with overview/summary
• Include code examples
• Add troubleshooting sections
• Link to related docs
• Keep up to date

---

Last Updated: November 2025