Skip to content

Website: MkDocs Material site under docs/, deployed to GitHub Pages - #87

Merged
v1k70rk4 merged 1 commit into
masterfrom
website
Nov 7, 2026
Merged

v1k70rk4 merged 1 commit into
masterfrom
website

Conversation

@v1k70rk4

@v1k70rk4 v1k70rk4 commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Why

The README's website badge points at https://v1k70rk4.github.io/RemoteAppClient/, which did not exist. This is the site: what RemoteAppClient is, how to get it running, what it does, how it is secured, and the reference, with screenshots.

What

  • mkdocs.yml + docs/: MkDocs with the Material theme, the console's colours; Home, Get started (server, first device, consoles), Features (remote access, fleet, updates, diagnostics), Security (model, keys), Reference (architecture, configuration, commands), Changelog, Development, About.
  • website/: the template override (titles, Open Graph, JSON-LD), hooks.py (the changelog page shows CHANGELOG.md, the keys page deploy/KEYS.md; files under docs/ that git ignores are left out of the build), and the pinned, hash-locked requirements.txt.
  • .github/workflows/docs.yml: builds the site on every pull request that touches it; deploys to GitHub Pages on a push to master (Pages source: GitHub Actions).
  • docs/images/: the icon and thirteen screenshots of the console with every device name, user, address, group and contact replaced.
  • .gitignore: site/ and .venv/.

Builds with mkdocs build --strict.

🤖 Generated with Claude Code

The README's "website" badge pointed at a page that did not exist. The site is built from docs/ with the Material theme (mkdocs.yml, website/ for the template override, the hooks and the pinned requirements) and deployed by .github/workflows/docs.yml on a push to master; a pull request only builds it. The changelog page shows CHANGELOG.md and the keys page shows deploy/KEYS.md, pulled in by website/hooks.py, which also leaves out any file under docs/ that git ignores. Thirteen screenshots of the console with every name, address and contact replaced.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 7, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@v1k70rk4
v1k70rk4 merged commit 419b38d into master Nov 7, 2026
11 checks passed
@v1k70rk4
v1k70rk4 deleted the website branch November 7, 2026 23:47
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.

1 participant