Repository navigation
Add comprehensive documentation site with MkDocs Material - #191
Merged
Merged
Conversation
…tHub Pages The README now leads with what the add-on does and for whom (play YouTube, Twitch and 1000+ sites on Kodi), with a why section, a table of the ways to send links, a short FAQ and links into the documentation instead of the long settings and integration details, which moved to docs/. docs/ is the complete documentation: installation, usage, every setting, integration (plugin URL, JSON-RPC, playlists, STRM, other add-ons, Home Assistant), how it works (managed runtimes, DASH builder, stream selection, files on disk), troubleshooting, FAQ and development. Each page carries a meta description. mkdocs.yml and .github/workflows/docs.yml build it with MkDocs Material and publish it to https://firsttris.github.io/plugin.video.sendtokodi/ on every push to master that touches the docs; pull requests only check that it builds (mkdocs build --strict). Same setup as in ccu-addon-mui. addon.xml's website now points to the site. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015B7K61R8J6Co4SD52onGVF
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #191 +/- ##
=======================================
Coverage 75.88% 75.88%
=======================================
Files 14 14
Lines 2380 2380
=======================================
Hits 1806 1806
Misses 574 574 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
This PR adds a complete documentation website for the SendToKodi Kodi add-on, built with MkDocs Material and published to GitHub Pages.
Summary
The documentation was previously scattered across the README and inline comments. This change consolidates it into a structured, searchable website at https://firsttris.github.io/plugin.video.sendtokodi/ with dedicated pages for each topic.
Key changes
New documentation structure (
docs/directory):installation.md- Installation requirements and setup instructionsusage.md- How to send links from browsers, Android, iPhone, and Kodisettings.md- Complete settings reference with descriptionstroubleshooting.md- Common issues and solutionsfaq.md- Frequently asked questionsintegration.md- JSON-RPC API, plugin URL format, and integration exampleshow-it-works.md- Architecture and internal flow documentationdevelopment.md- Setup, testing, and contribution guidelinesREADME.md- Documentation homepageMkDocs configuration (
mkdocs.yml):Build automation (
.github/workflows/docs.yml):Styling (
docs/assets/):Dependencies (
requirements-docs.txt):README.md refactor:
Notable implementation details
https://claude.ai/code/session_015B7K61R8J6Co4SD52onGVF