Kototoro Documentation
This directory is organized by task, not by internal implementation. Start with the page that matches what you want to do next.
IMPORTANT
Kototoro does not bundle, host, or distribute any content sources, media, or copyrighted material. The application is a generic reader and player framework. All content sources are provided by the user through third-party extensions, local file imports, or self-configured JSON endpoints. The developers of Kototoro are not responsible for any content accessed through user-installed sources.
Join the community: Discord
Start Here
| If you want to... | Read this |
|---|---|
| Install the app and get productive quickly | Getting Started |
| Understand the product at a high level | Reader Features |
| Set up local OCR + translation | Automatic Translation |
| Connect external source ecosystems | Source Integrations |
| Sync across devices with WebDAV | WebDAV Sync |
| Get quick answers to common questions | FAQ |
| Solve common setup problems | Troubleshooting |
| Build, test, or contribute | Development and Contributing |
Documentation Map
For users
- Getting Started
- Reader Features — manga, novels, video, tracking discovery, DLNA, subtitles
- Automatic Translation
- Source Integrations — built-in, Kotatsu-Redo, Mihon, Aniyomi, IReader, Legado, TVBox
- WebDAV Sync
- FAQ
- Troubleshooting
For advanced users
- Architecture Review
- Architecture Roadmap
- UI Improvement
- OCR Pipeline Notes
- Mihon Integration Reference
- Kotatsu-Redo Integration Reference
For contributors
Design drafts
Archived materials
Documentation Rules
README.mdstays short and product-oriented.docs/keeps task-oriented guides and reference material.- User-facing guides should explain what a feature is, when to use it, and how to set it up.
- Contributor-facing guides should focus on build, verification, and change expectations.
- Time-sensitive review packs and superseded language variants belong in
archive/.