dangernoodle-io / breadboard / 29877158485

96%

push

github

feat: hierarchical component docs + nested-layout build glue (#984)

- gen_components_readme.py: two-level index (components/README.md rows per
  group + ungrouped component; components/<group>/README.md gets its own
  generated index in a bbtool:group-index marker region below hand-authored
  prose); routed through discovery.py's leaf-rule SSOT instead of a depth-1
  iterdir(); a group dir with no README, or a README with no group-index
  marker, fails loud (GroupReadmeError) rather than rendering an em-dash
- bbtool docs.py: gen_all/_check_component_readme are TWO-PASS -- the
  pre-hierarchy depth-1 iterdir() walk stays fully intact (so a bare/
  malformed components/<name>/ dir with no CMakeLists.txt is still
  regenerated/flagged exactly as before, never silently dropped), plus a
  supplemental discovery-SSOT pass adds coverage for components nested
  under components/<group>/<name>/ that the depth-1 walk can't reach.
  Dedup between the two passes is PATH-aware, not name-aware: pass 2 skips
  a discovery-indexed leaf only when its resolved DIRECTORY is identical to
  one pass 1 already walked, never merely because its bare name matches a
  pass-1 directory -- discovery's collision guard only fires between two
  INDEXED leaves, so an undiscovered flat dir can legitimately share a name
  with an unrelated real nested leaf elsewhere. New `_header_for_dir`
  resolves a component's header from an ALREADY-KNOWN directory rather than
  a fresh by-name discovery lookup, so `_render_brief`/the lint's brief
  check can never mis-attribute an unrelated same-named component's
  @brief; `_gen_component_readme`/`_render_api`/`_render_brief` all take an
  optional pre-resolved comp_dir so it's threaded through instead of
  re-derived mid-pipeline. scaffold resolves a component's real on-disk dir
  via discovery (flat fallback when not yet discoverable); new
  `docs scaffold --group <name>` stamps a group README stub (prose
  placeholder + empty group-index mark... (continued)

7456 of 8052 branches covered (92.6%)

Branch coverage included in aggregate %.

12625 of 12787 relevant lines covered (98.73%)

1208.9 hits per line