sjat/MakerFLOSS
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MakerFLOSS/scripts
History
sjat 41c4834dbd
All checks were successful
Build docs site / build (push) Successful in 46s
Details
Build slides / build (push) Successful in 1m7s
Details
fix(docs-ci): unblock build by tolerating "?" placeholders in hardware frontmatter 
mf00.md used bare ? in YAML (a complex-key indicator), breaking gen_overview.py.
Quoted the placeholders and taught fmt_cpu/fmt_ram/fmt_storage/fmt_nic to render
string values literally so unknown specs show as "?" in both the per-host Specs
table and the hardware index. Also regenerates docs/hardware/index.md to clear
the accumulated drift (mf02 16 GB, mf04 entry, mf00 custom).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-27 10:31:46 +02:00
..
gen_overview.py fix(docs-ci): unblock build by tolerating "?" placeholders in hardware frontmatter 2026-05-27 10:31:46 +02:00
mkdocs_hooks.py feat(docs): add services category alongside hardware 2026-05-18 17:48:15 +02:00
overview_config.yml feat(docs): add services category alongside hardware 2026-05-18 17:48:15 +02:00
README.md docs: add proper README at repo root and per-tree READMEs 2026-05-18 17:13:50 +02:00

README.md

scripts/

Build helpers for the documentation site.

  • gen_overview.py — generates a category index table from per-item YAML frontmatter (currently used for docs/hardware/index.md). Configured by overview_config.yml. Run via make docs-index; CI drift-checks it via make docs-check.
  • mkdocs_hooks.py — MkDocs build hook that renders a Specs table on each hardware host page from its frontmatter, sharing fmt_* helpers with gen_overview.py so the host page and the index row stay in sync.
  • overview_config.yml — schema (required fields, enums) and table layout for gen_overview.py.