sjat/MakerFLOSS
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MakerFLOSS/scripts
History
sjat 4dc975062a
All checks were successful
Build docs site / build (push) Successful in 49s
Details
Build slides / build (push) Successful in 1m11s
Details
docs(hardware): reconcile rack01 to as-mounted layout and document cabling 
Rebuild rack01 from the physically remounted hardware:
- Correct stale positions/ports/outlets for pp01, pp02, sw01, pdu01-04
- Model shelves as 1U trays (towers stand above without consuming rack U's);
  add shf02 and empty half-depth shf03/shf04
- Add ups01/ups02; reseat nas01/02 and sw02-05; move srv04-07 onto shf02
- Add `wan` hardware kind; add WAN demarcation hosts wan01 (active) and
  wan02 (staging)
- Document full live network wiring: srv01-07 -> pp02 -> sw01 (LAN) and
  srv01 eth0 -> pp02 -> pp01 -> wan01 (WAN); keep non-active lines
  (wan2, working-table patches, sw01 mgmt) in notes only
- Regenerate hardware index + rack01 elevation/network/power artifacts

Also includes the in-progress generator updates (gen_rack.py, gen_overview.py,
Makefile, tests) that the regenerated artifacts depend on.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-30 21:31:48 +02:00
..
gen_overview.py docs(hardware): reconcile rack01 to as-mounted layout and document cabling 2026-06-30 21:31:48 +02:00
gen_rack.py docs(hardware): reconcile rack01 to as-mounted layout and document cabling 2026-06-30 21:31:48 +02:00
mkdocs_hooks.py docs(hardware): drop the model field 2026-05-27 10:37:04 +02:00
overview_config.yml docs(hardware): reconcile rack01 to as-mounted layout and document cabling 2026-06-30 21:31:48 +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.