62fcd8ac27
- Rewrite the 84-byte Danish placeholder README.md into a proper English entry point: what this repo is, live URLs, layout, build instructions (make targets), and conventions, with pointers to CLAUDE.md for the long form. - Add short READMEs to notes/, sandbox/, and scripts/ so each tree documents its own purpose at the boundary where someone is likely to land on it via the Forgejo web UI or a clone. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
7 lines
610 B
Markdown
7 lines
610 B
Markdown
# 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`.
|