docs(installation): add Rouzax Repository as an install method#25
Merged
Conversation
The personal Kodi addon repository at github.com/Rouzax/repository.rouzax publishes EasyTV's latest stable releases automatically at release time (Step 5g of the release skill runs publish.py on every stable release), ahead of the official Kodi repo's review cycle. This was missing from the installation page entirely. Restructured Installation Methods to present three paths in a single comparison table (auto-updates, latest stable timing, setup effort), then describes each: - Rouzax Repository (recommended): one-time repo install via the repository.rouzax zip, after which Kodi handles all future EasyTV updates automatically. Latest stable release available immediately. - Official Kodi Add-on Repository: already enabled in every Kodi install, no extra setup, but versions arrive only after Kodi's review cycle and may lag. - GitHub release zip: manual per-release zip install, suitable for pre-releases (alpha/beta) and bleeding-edge testing. The "easiest" framing on the official Kodi Repository was misleading because it implied lowest user friction; the Rouzax repository is arguably easier in steady state since updates flow automatically once the repo zip is installed once. Adjusted wording.
The Phase 1-3 docs overhaul (PRs #6 through #22) treated docs/*.md as in-scope but never explicitly listed README.md, so its content drifted: 1. 11 em-dashes never stripped, despite Phase 1's commit message claiming README was covered. 2. Installation section still listed only the GitHub-zip method, never updated to mention the Rouzax Repository or the official Kodi add-on repository. 3. Documentation Map linked to /docs/advanced-features/, which Phase 3 deleted (split into Clones / Episode Export / Auto-Generated Playlists). 4. Multi-Instance Sync Quick Setup told users to "pip install pymysql", which is wrong: pymysql ships as the script.module.pymysql Kodi addon and is auto-installed as an EasyTV dependency. Changes ------- - Stripped all 11 em-dashes (replaced with colons). - Replaced single-method install with the same three-method comparison introduced for docs/installation.md, surfacing the Rouzax Repository as the recommended path (auto-updates via Kodi at release time, no Kodi-review lag). - Documentation Map now lists the three split-off pages instead of the deleted advanced-features.md. - Multi-Instance Sync Quick Setup cleaned up: pymysql is delivered via the Kodi addon dependency, not pip; setup path now matches the actual setting label "Enable multi-instance sync" under Settings -> Advanced -> Multi-Instance Sync.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Rouzax personal Kodi addon repository (https://github.com/Rouzax/repository.rouzax) publishes EasyTV's latest stable releases automatically at release time (Step 5g of the release skill runs
publish.pyon every stable release), ahead of the official Kodi repo's review cycle. The installation page didn't mention it at all.Changes
Restructured "Installation Methods" to present three paths with a comparison table at the top, then describe each:
The previous "easiest" framing on the official Kodi Repository was misleading: in steady state the Rouzax Repository is friendlier because updates flow automatically once the repository zip is installed once, and they're not delayed by Kodi's review cycle.
Test plan
mkdocs build --strictpasses