pub fn compose_overview(
engine: &mut Engine,
args: OverviewArgs<'_>,
surface: Surface,
) -> Result<OverviewOutput, ComposeOverviewError>Expand description
Compose the overview markdown for either surface.
The function mutates the engine in two well-bounded ways:
- Calls
engine.invalidate_communities()whenargs.rebuildis true, so the nextengine.communities()triggers a fresh Louvain run. engine.communities()itself caches lazily — first call after a write or after invalidation re-computes.
All other accesses are read-only. The function does NOT collect drift warnings or apply chunking — both are the surface’s job.