6b1a61461b
Bootstraps an MkDocs Material documentation site (rendered to
docs.makerfloss.eu by the Forgejo Actions runner). The first feature
is an auto-generated hardware overview built from per-host YAML
frontmatter blocks under docs/hardware/.
- mkdocs.yml, requirements.txt: MkDocs Material 9.5 + pyyaml
- Makefile: docs-index | docs-build | docs-serve | docs-check
- scripts/gen_overview.py: stdlib + pyyaml generator, deterministic and
offline. Reads scripts/overview_config.yml — category-driven so
services/vms can plug in later without touching the script.
- scripts/overview_config.yml: hardware schema and index layout
- docs/hardware/{makerfloss,fisi,tembo}.md: 3 sample entries
- docs/hardware/index.md: GENERATED, committed (CI fails on drift)
- docs/index.md: site landing page
- .forgejo/workflows/docs.yml: drift-check + mkdocs build --strict +
rsync site/ to /srv/docs-makerfloss/html on push to main
- .gitignore: site/, .venv, __pycache__
Schema:
- hostname, kind, status (required; kind/status are enums)
- model, location, cpu, cpu_cores, cpu_threads, ram_gb, storage_gb,
storage_type (enum), storage_notes, nic_gbps (all optional)
- Filename stem MUST equal hostname (enforced by generator)
- Extra optional fields are accepted silently and live on the per-page
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
25 lines
734 B
Makefile
25 lines
734 B
Makefile
.PHONY: help docs-index docs-build docs-serve docs-check slides
|
|
|
|
help:
|
|
@echo "Targets:"
|
|
@echo " docs-index Regenerate docs/hardware/index.md from per-host frontmatter"
|
|
@echo " docs-build Build the static MkDocs site into ./site (strict)"
|
|
@echo " docs-serve Run a live-reload local preview server"
|
|
@echo " docs-check Drift-check: regenerate index, fail if it differs from the committed copy"
|
|
@echo " slides Run build-slides.sh (Marp slides)"
|
|
|
|
docs-index:
|
|
python3 scripts/gen_overview.py --category hardware
|
|
|
|
docs-build:
|
|
mkdocs build --strict
|
|
|
|
docs-serve:
|
|
mkdocs serve
|
|
|
|
docs-check:
|
|
python3 scripts/gen_overview.py --category hardware
|
|
git diff --exit-code docs/hardware/index.md
|
|
|
|
slides:
|
|
./build-slides.sh
|