Skip to content

Add comprehensive documentation site with MkDocs Material - #191

Merged
firsttris merged 1 commit into
masterfrom
claude/centocodi-readme-mkdocs-docs-1c5hfz
Oct 8, 2026
Merged

firsttris merged 1 commit into
masterfrom
claude/centocodi-readme-mkdocs-docs-1c5hfz

Conversation

@firsttris

Copy link
Copy Markdown
Owner

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 instructions
    • usage.md - How to send links from browsers, Android, iPhone, and Kodi
    • settings.md - Complete settings reference with descriptions
    • troubleshooting.md - Common issues and solutions
    • faq.md - Frequently asked questions
    • integration.md - JSON-RPC API, plugin URL format, and integration examples
    • how-it-works.md - Architecture and internal flow documentation
    • development.md - Setup, testing, and contribution guidelines
    • README.md - Documentation homepage
  • MkDocs configuration (mkdocs.yml):

    • Material theme with custom SendToKodi blue color scheme
    • Navigation structure organized by user type (Users, Integration, Background)
    • Search, syntax highlighting, and git revision date plugins
    • Mobile-friendly responsive design
  • Build automation (.github/workflows/docs.yml):

    • Automatic documentation build and deployment to GitHub Pages on master branch
    • Validates documentation builds on pull requests
  • Styling (docs/assets/):

    • Custom CSS for SendToKodi branding
    • Icon and favicon assets
  • Dependencies (requirements-docs.txt):

    • MkDocs Material 9.7.7
    • Git revision date plugin for automatic last-modified dates
  • README.md refactor:

    • Condensed to a focused overview with links to detailed documentation
    • Improved visual hierarchy and feature highlights
    • Links to all documentation pages and integration methods

Notable implementation details

  • Documentation uses YAML frontmatter for metadata (descriptions for SEO)
  • Mermaid diagrams for architecture visualization
  • Admonitions and tabs for better content organization
  • All documentation is version-controlled and built from source
  • GitHub Pages deployment is automatic on master branch pushes

https://claude.ai/code/session_015B7K61R8J6Co4SD52onGVF

…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-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.88%. Comparing base (3303e03) to head (2c36bd9).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@firsttris
firsttris merged commit b5e27a0 into master Oct 8, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants