Zum Inhalt springen
Kitbay
Skill

understand-onboard

MITAktualisiert am 18. Nov. 202693.199GitHub-Sterne

A skill from the Understand Anything plugin that writes an onboarding guide for developers new to a project, built from the knowledge graph the plugin's main analysis skill produces.

Was der Skill vermittelt

A skill from the Understand Anything plugin that writes an onboarding guide for developers new to a project, built from the knowledge graph the plugin's main analysis skill produces. It finds the graph file in the project's .ua folder (or the older folder name), asks the user to run the analysis first if it is missing, and warns when source files have changed since the commit the graph records. It then reads the project overview, architecture layers, guided tour and file-level entries, leaving out function and class detail, and produces a markdown guide with an overview, layers, key concepts, a tour, a file map and complexity hotspots, which can be saved to the docs folder and committed.

Funktionen

  • Write an onboarding guide from a codebase knowledge graph
  • Warn when the graph is out of date
  • Summarise architecture layers and complexity hotspots