Mirror the auto-indexed per-host pattern for a new docs/services/ category, seeded with the six things currently deployed on or around makerfloss.eu: docs, slides, forgejo, gandi-dns, marp, mermaid. Generator/hook generalisation: - scripts/gen_overview.py: replace the hardcoded `hostname` check with a configurable `key_field` (default: hostname). Add a generic `key-link` column kind (replaces the old `hostname-link`) and a `url-link` kind that renders the value as a clickable link. - scripts/overview_config.yml: declare hardware's key_field, then add a `services` block (key_field=name, its own kind/status enums, grouped by kind for the index table). - scripts/mkdocs_hooks.py: route by `page.file.src_uri` so each hardware/* page gets a "Specs" table and each services/* page gets a "Service" table; both share the helpers in gen_overview. Wiring: - Makefile: docs-index and docs-check now regenerate and drift-check both indices. - .forgejo/workflows/docs.yml: same on the CI runner. - mkdocs.yml: add Services to nav. - README.md, CLAUDE.md: list services/ in the repo-layout block. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| gen_overview.py | ||
| mkdocs_hooks.py | ||
| overview_config.yml | ||
| README.md | ||
scripts/
Build helpers for the documentation site.
gen_overview.py— generates a category index table from per-item YAML frontmatter (currently used fordocs/hardware/index.md). Configured byoverview_config.yml. Run viamake docs-index; CI drift-checks it viamake docs-check.mkdocs_hooks.py— MkDocs build hook that renders a Specs table on each hardware host page from its frontmatter, sharingfmt_*helpers withgen_overview.pyso the host page and the index row stay in sync.overview_config.yml— schema (required fields, enums) and table layout forgen_overview.py.