MkDocs hub site for the Lightnet project — a modular addressable lighting system. This repo hosts the landing page and shared reference docs. Firmware and mobile docs live in their own repos and are pulled in at build time via mkdocs-monorepo-plugin.
| Repo | Description |
|---|---|
| lightnet | This hub — landing page, shared glossary, FAQ, release notes |
| lightnet-firmware | ESP8266/ESP32 controller + ATmega panel firmware |
| lightnet-mobile | Kotlin Multiplatform app for Android and iOS |
Clone all three repos side-by-side:
parent/
lightnet/ ← this repo
lightnet-firmware/
lightnet-mobile/
Then:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serveOpen http://localhost:8000.
mkdocs serve is the normal editing loop — fast rebuilds, live reload — but it
renders only your working tree and doesn't show the version switcher or
aliases. To preview the site as it appears on GitHub Pages:
git fetch origin gh-pages:gh-pages
mike serveThis serves the already-committed gh-pages branch, not uncommitted edits.
To try out a new version locally before publishing, run
mike deploy <version> <alias> without --push first, then mike serve.
Never run mike deploy ... --push locally against origin unless you mean
to publish for real.
Preview/beta versions published via the Deploy Preview Docs GitHub Action
are not auto-expired — remove them once obsolete with
mike delete <version> --push.
Firmware and mobile app are licensed under GPL-3.0.