dotfiles
bugabingas dorkfiles
owned by bugabinga
test(quickshell): audit docs index
119547362a61b78b2e4e467df98ee635fc050239
Oliver Jan Krylow <oliver@bugabinga.net> ·
unsigned
Browse filesCompare with HEAD
Changed files (2)
docs/super/inventory/2026-06-17-quickshell-self-contained-audit.md
Modified 13 13 `quickshell/nugu/audit.sh` checks repository state only:
15 15 - required named-config files are present: `shell.qml`, `Theme.qml`, `nugu.json`, `README.md`, `COMPONENTS.md`, `IPC.md`, `EXTERNALS.md`, `SERVICE.md`, `PARITY.md`, `audit.sh`, `smoke.sh`.
16 +- `README.md` links the required inventories, service/parity contracts, smoke/audit gates, named config command, and IPC command form.
16 17 - every QML component is listed in `COMPONENTS.md` with purpose and rollout status.
17 18 - every `nugu` IPC method from `shell.qml` is listed in `IPC.md` with purpose and rollout status.
18 19 - component, IPC, and external inventory rows reject duplicates, malformed names, thin text, and placeholder wording.
60 61 documented_external_commands=25
61 62 detected_external_commands=25
62 64 inventory_tables=ok
63 65 service_contract=ok
78 80 documented_external_commands=25
79 81 detected_external_commands=25
80 83 inventory_tables=ok
81 84 service_contract=ok
quickshell/nugu/audit.sh
Modified 26 26 if not (config_dir / name)
.exists():
27 27 errors.append(f
"missing required self-contained config file {name}")
29 +readme_path = config_dir /
"README.md" 30 +if readme_path.exists():
31 + readme_text = readme_path.read_text()
32 + for marker in (
"COMPONENTS.md",
"IPC.md",
"EXTERNALS.md",
"SERVICE.md",
"PARITY.md",
"audit.sh",
"smoke.sh",
"qs -c nugu",
"qs ipc -c nugu")
: 33 + if marker not in readme_text:
34 + errors.append(f
"README.md missing self-contained entry marker {marker!r}")
36 + errors.append(
"missing README.md")
30 39 errors.append(
"no QML files found")
310 319 print(f
"documented_ipc={len(documented_ipc)}")
311 320 print(f
"documented_external_commands={len(external_commands)}")
312 321 print(f
"detected_external_commands={len(detected)}")
322 +print(
"docs_index=ok")
313 323 print(
"inventory_tables=ok")
314 324 print(
"service_contract=ok")
315 325 print(
"parity_matrix=ok")