Skip to content

docs: add GitHub Pages documentation site - #12

Merged
xulek merged 20 commits into
mainfrom
docs/github-pages
Sep 6, 2026
Merged

xulek merged 20 commits into
mainfrom
docs/github-pages

Conversation

@xulek

@xulek xulek commented Sep 6, 2026

Copy link
Copy Markdown
Owner

Summary

Adds a complete GitHub Pages documentation site for PyVNCServer using MkDocs Material.

Included

  • polished landing page with responsive custom styling and project logo
  • installation and quick-start guide
  • full TOML configuration reference based on the current safe defaults
  • UltraVNC compatibility guide, including Tight/RRE troubleshooting
  • noVNC/WebSocket guide updated for the web/noVNC Git submodule
  • encoding reference
  • security/deployment guide
  • CLI and Python API reference
  • architecture and performance documentation
  • troubleshooting and development guides
  • light/dark theme, search, Mermaid diagrams and code-copy support
  • GitHub Pages workflow with strict MkDocs builds on PRs and deployment from main

GitHub Pages

After merge, configure Settings → Pages → Build and deployment → Source → GitHub Actions if the repository is not already using Actions as its Pages source.

The expected documentation URL is:

https://xulek.github.io/PyVNCServer/

Validation

The branch is documentation-only. The workflow runs mkdocs build --strict before deployment. Local dependency installation could not be executed in the ChatGPT container because that runtime has no PyPI/network access; GitHub-hosted runners will perform the strict build.

Note: main received the noVNC submodule commit after this branch was created. The documentation already reflects that new submodule setup; the branch changes do not overlap the .gitmodules/submodule commit.

@xulek
xulek merged commit c72aed5 into main Sep 6, 2026
14 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.

1 participant