[Proposal] Set Up a Free Documentation Website via GitHub Pages

Author: HYP3R00TCreated Mar 8, 2026Updated Jun 14, 2026

Problem

The README is getting long. As more people find this project, mixing user-facing setup instructions with developer internals in one file makes it hard for either audience to find what they need.

Proposal

Set up a documentation site with two clear sections:

  • Users: installation, hardware requirements, running the wizard, understanding outputs
  • Developers: architecture, modules, contribution guide, the existing LLM handover doc

Tool

Zensical (https://zensical.org) — built by the same team behind Material for MkDocs, designed for exactly this kind of technical documentation. Docs are written in plain Markdown, so contributing to them requires no frontend knowledge.

Hosting

GitHub Pages, completely free. A GitHub Actions workflow builds and deploys the site on every push to main. The site goes live at https://nikopueringer.github.io/CorridorKey with the option to attach a custom domain later.

Happy to put together a draft setup if this is something you would want.

Source: nikopueringer/CorridorKey