📚 docs: Comprehensive Syncthing Setup Documentation

[fpigeonjr]

Problem Statement

While KOShelf includes excellent Syncthing integration with sophisticated dual-detection systems, the current documentation leaves several gaps that make initial setup challenging for new users. The README covers the basics but lacks the detailed step-by-step guidance needed for a smooth first-time experience.

Current Documentation Gaps

1. Missing Step-by-Step Setup Guide

• No clear progression from "install Syncthing" to "working sync"
• Device pairing process not documented
• Folder configuration lacks specific screenshots/examples

2. KOReader Plugin Setup Unclear

• Plugin installation instructions are minimal
• No troubleshooting for plugin issues
• Configuration within KOReader not covered

3. Network Configuration Missing

• Local network discovery requirements not explained
• Firewall/router settings not mentioned
• Device IP configuration guidance absent

4. Troubleshooting Section Incomplete

• No sync conflict resolution guidance
• Connection failure debugging missing
• Platform-specific issues (macOS, Linux) not addressed

[fpigeonjr]

love the project and having better documentation to get syncthing working would be helpful for new users.

[paviro]

Hi!
I don’t use the Syncthing koreader plugin as I am on an Android device.

I would very much welcome a PR with better Syncthing documentation but I am not super hyped to write it myself 🙈 for now I figured the Syncthing website would be okay since they do offer documentation on how to set up Syncthing.