Developer Documentation Site (BME-KONZA-HQ)
The internal developer-documentation site served at hq.bme-konza.org. (This is where the publish-safe half of this handover lives — see the migration note.)
Stack
- MkDocs (Python),
readthedocstheme. - Config: mkdocs.yml. Content:
docs/*.md. - Build → static
site/→ served by nginx (Dockerfile) / Coolify (nixpacks).
Layout
mkdocs.yml # site config + nav
docs/
index.md, getting-started.md, platform.md, stack.md
handover/ # ← publish-safe handover docs migrated here
Dockerfile # python:3.11 → mkdocs build → nginx:alpine (port 80)
Dockerfile.dev # local live-reload
nixpacks.toml # pip install mkdocs; mkdocs build
Makefile # dev-build / dev-start (docker, :8000)
Run locally
cd BME-KONZA-HQ
pip install mkdocs
mkdocs serve # live preview at http://127.0.0.1:8000
# or, matching prod:
make dev-build && make dev-start
Deploy
Coolify builds via nixpacks (pip install mkdocs && mkdocs build) and serves site/ via
nginx at hq.bme-konza.org. [TODO: confirm the Coolify app + deploy trigger — does it use
the same tag-based webhook flow as the other repos? See deployment.md.]
⚠️ hq.bme-konza.org is PUBLIC (verified: HTTP 200, no auth). Never put secret values, server IPs/SSH, credentials, or personal contact details in this repo. Those stay in the private handover set + the vault.
Public vs private docs
This site is the canonical home for the technical documentation — architecture, the
component deep-dives, deployment, local development, and the roadmap all live in docs/.
A separate private set covers operational material that must never be published: onboarding/access, the secrets inventory, infrastructure (server/DNS), contacts/billing, and disaster recovery. That set lives outside this repo (private handover folder + the vault) and is intentionally not on this site.