Skip to main content

Module tour

Module tour 

Source
Expand description

Guided-tour generation — deterministic graph traversal that picks the “important” symbols of a repo (or of a seeded subgraph) and orders them so a reader can walk through the codebase top-down.

Algorithm (pure graph, no LLM):

  1. Build adjacency from Contains + Calls edges.
  2. Score each node by in-degree across Calls (centrality).
  3. Pick top-K nodes globally, or BFS from a seed when one is provided.
  4. Return ordered tour steps with rationale per step.

Structs§

Component
A component (directory/module) in the architecture summary.
Tour
TourStep
One step in a generated tour.

Functions§

generate
Generate a tour for branch. If seed is Some, the tour is rooted at that symbol and walks outward via Calls and Contains edges. If None, the tour picks the highest-centrality public entry points across the repo.
render_markdown
Render a tour as a human-readable markdown plan.