117 lines
3.5 KiB
Markdown
117 lines
3.5 KiB
Markdown
# Documentation Index
|
|
|
|
## Quick Start
|
|
- [README](../README.md) - Project overview and quick start
|
|
- [QUICKSTART](../QUICKSTART.md) - Detailed 5-minute setup guide
|
|
|
|
## Setup & Configuration
|
|
- [OLLAMA_SETUP](OLLAMA_SETUP.md) - Ollama AI service setup
|
|
- [GPU_SETUP](GPU_SETUP.md) - GPU acceleration setup (5-10x faster)
|
|
- [DEPLOYMENT](DEPLOYMENT.md) - Production deployment guide
|
|
|
|
## API Documentation
|
|
- [ADMIN_API](ADMIN_API.md) - Admin endpoints (crawl, send newsletter)
|
|
- [API](API.md) - Public API endpoints
|
|
- [SUBSCRIBER_STATUS](SUBSCRIBER_STATUS.md) - Subscriber status system
|
|
|
|
## Architecture & Design
|
|
- [SYSTEM_ARCHITECTURE](SYSTEM_ARCHITECTURE.md) - Complete system architecture
|
|
- [ARCHITECTURE](ARCHITECTURE.md) - High-level architecture overview
|
|
- [DATABASE_SCHEMA](DATABASE_SCHEMA.md) - MongoDB schema and connection
|
|
- [BACKEND_STRUCTURE](BACKEND_STRUCTURE.md) - Backend code structure
|
|
|
|
## Features & How-To
|
|
- [CRAWLER_HOW_IT_WORKS](CRAWLER_HOW_IT_WORKS.md) - News crawler explained
|
|
- [EXTRACTION_STRATEGIES](EXTRACTION_STRATEGIES.md) - Content extraction
|
|
- [RSS_URL_EXTRACTION](RSS_URL_EXTRACTION.md) - RSS feed handling
|
|
- [PERFORMANCE_COMPARISON](PERFORMANCE_COMPARISON.md) - CPU vs GPU benchmarks
|
|
|
|
## Security
|
|
- [SECURITY_NOTES](SECURITY_NOTES.md) - Complete security guide
|
|
- Network isolation
|
|
- MongoDB security
|
|
- Ollama security
|
|
- Best practices
|
|
|
|
## Reference
|
|
- [CHANGELOG](CHANGELOG.md) - Version history and recent updates
|
|
- [QUICK_REFERENCE](QUICK_REFERENCE.md) - Command cheat sheet
|
|
|
|
## Contributing
|
|
- [CONTRIBUTING](../CONTRIBUTING.md) - 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](../README.md) - Overview
|
|
2. [QUICKSTART](../QUICKSTART.md) - Step-by-step setup
|
|
|
|
**Enable GPU acceleration:**
|
|
1. [GPU_SETUP](GPU_SETUP.md) - Complete GPU guide
|
|
2. Run: `./start-with-gpu.sh`
|
|
|
|
**Send newsletters:**
|
|
1. [ADMIN_API](ADMIN_API.md) - API documentation
|
|
2. [SUBSCRIBER_STATUS](SUBSCRIBER_STATUS.md) - Subscriber system
|
|
|
|
**Understand the architecture:**
|
|
1. [SYSTEM_ARCHITECTURE](SYSTEM_ARCHITECTURE.md) - Complete overview
|
|
2. [DATABASE_SCHEMA](DATABASE_SCHEMA.md) - Database design
|
|
|
|
**Secure my deployment:**
|
|
1. [SECURITY_NOTES](SECURITY_NOTES.md) - Security guide
|
|
2. [DEPLOYMENT](DEPLOYMENT.md) - Production deployment
|
|
|
|
**Troubleshoot issues:**
|
|
1. [QUICK_REFERENCE](QUICK_REFERENCE.md) - Common commands
|
|
2. [OLLAMA_SETUP](OLLAMA_SETUP.md) - Ollama troubleshooting
|
|
3. [GPU_SETUP](GPU_SETUP.md) - 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
|