Documentation
Getting Started
- Quick Start - Install, configure, and run your first fetch
- Daily Workflow - Fetch, browse, automate
Tutorials
Step-by-step guides for new users.
- 01 - Getting Started
- 02 - Daily Workflow
- 03 - Interactive Mode
- 04 - Managing Sources
- 05 - Organising with Bundles
- 06 - Customising Output
User Guides
- Interactive Mode - TUI navigation and flows
- Configuration - Global settings, per-source overrides
- Deployment - Cron, systemd, production setup
- Testing - Running and writing tests
- Ethical Scraping - Rate limits, compliance, robots.txt
Source Management
- Add a Source - RSS URL or manual YAML
- Remove a Source - CLI removal with backup
- Remove Source - Advanced - Dry run, undo, edge cases
- Source Management Menu - TUI source management
- Source Development - Build custom Python sources
- RSS News Sources Reference - Feed catalogue
Architecture
- Architecture Overview - Components, source types, data flow
- System Architecture Diagram
- Data Flow Diagram
- Processing Pipeline
- Source System
- Class Diagrams
- Deployment Architecture
Developer
- Developer Guide - Setup, conventions, contributing
- Git Workflow - Branching, commits, releases
- Testing Guide - Unit tests, acceptance tests
- Release Process - Version bumps, PyPI publish
API Reference
Auto-generated from source. Covers all public modules and classes.
- Overview
- CLI
- Article Fetcher
- Source Registry
- Config
- TUI
- Unified Media Processor
- HTML Generator
- Ethical Scraping
- Storage Manager