// Use when you need to generate an onboarding guide for new team members joining a project
| name | understand-onboard |
| description | Use when you need to generate an onboarding guide for new team members joining a project |
Generate a comprehensive onboarding guide from the project's knowledge graph.
The knowledge graph JSON has this structure:
project — {name, description, languages, frameworks, analyzedAt, gitCommitHash}nodes[] — each has {id, type, name, filePath?, summary, tags[], complexity, languageNotes?}
file:path, function:path:name, config:path, article:pathedges[] — each has {source, target, type, direction, weight}
layers[] — each has {id, name, description, nodeIds[]}tour[] — each has {order, title, description, nodeIds[]}Check that .understand-anything/knowledge-graph.json exists. If not, tell the user to run /understand first.
Read project metadata — use Grep or Read with a line limit to extract the "project" section (name, description, languages, frameworks).
Read layers — Grep for "layers" to get the full layers array. These define the architecture and will structure the guide.
Read the tour — Grep for "tour" to get the guided walkthrough steps. These provide the recommended learning path.
Read file-level structural nodes only — use Grep to find nodes with file-level types (file, config, document, service, pipeline, table, schema, resource, endpoint) in the knowledge graph. Skip function-level and class-level nodes to keep the guide high-level. Extract each node's name, filePath, summary, and complexity.
Identify complexity hotspots — from the file-level nodes, find those with the highest complexity values. These are areas new developers should approach carefully.
Generate the onboarding guide with these sections:
Format as clean markdown
Offer to save the guide to docs/ONBOARDING.md in the project
Suggest the user commit it to the repo for the team
Analyze a codebase to produce an interactive knowledge graph for understanding architecture, components, and relationships
Use when you need to ask questions about a codebase or understand code using a knowledge graph
Use when you need to analyze git diffs or pull requests to understand what changed, affected components, and risks
Use when you need a deep-dive explanation of a specific file, function, or module in the codebase
Extract business domain knowledge from a codebase and generate an interactive domain flow graph. Works standalone (lightweight scan) or derives from an existing /understand knowledge graph.
Analyze a Karpathy-pattern LLM wiki knowledge base and generate an interactive knowledge graph with entity extraction, implicit relationships, and topic clustering.
