Documentation Index
This repository serves as a
single source of truth for the Ultimate Web Novel & Manga Scraper. Below is the directory of all available documentation.
Getting Started
- GETTING_STARTED.md: 🚀 Start here! Quick setup guide, first scraping rule, and common use cases.
- README.md: High-level overview, feature inventory, and project introduction.
- FAQ.md: Frequently asked questions covering installation, scraping, translation, and troubleshooting.
Core Documentation
- ARCHITECTURE.md: Deep dive into the system design, code structure, and data pipelines. Recommended for developers.
- DIRECTORY_STRUCTURE.md: A comprehensive map of every file and folder in the repository.
- DATA_FLOW.md: Detailed tracing of how data moves from scraping source to database.
Configuration & Deployment
- CONFIGURATION.md: Detailed reference for every setting and rule parameter.
- DEPLOYMENT.md: Server requirements, installation steps, and cron setup.
- TROUBLESHOOTING.md: Solutions for common errors (scraping failures, image issues, timeouts).
Developer Resources
- API_REFERENCE.md: Complete API documentation including hooks, filters, functions, REST endpoints, and code examples.
Security & Data
Legal & Governance
- LICENSE: The legal terms of use (LUCA Free License v1.0).
- NOTICE.md: Attributions for third-party libraries and code.
- CHANGELOG.md: History of changes and versions.
Quick Reference