cc74ad0bd0
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
- .woodpecker.yaml: image paths -> library/autojanet-{agent,dispatcher}
- .woodpecker.yaml: secret names RS_HARBOR_USER / RS_HARBOR_PASS (global)
- container/Dockerfile: restore COPY skills/, skills/ populated from opencode config
- skills/: 84 opencode skills bundled into image
- k8s/manifests: update image refs to library/
55 lines
3.3 KiB
Markdown
55 lines
3.3 KiB
Markdown
---
|
|
name: understand-onboard
|
|
description: Use when you need to generate an onboarding guide for new team members joining a project
|
|
---
|
|
|
|
# /understand-onboard
|
|
|
|
Generate a comprehensive onboarding guide from the project's knowledge graph.
|
|
|
|
## Graph Structure Reference
|
|
|
|
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?}
|
|
- Code node types: file, function, class, module, concept
|
|
- Non-code node types: config, document, service, table, endpoint, pipeline, schema, resource
|
|
- Domain/knowledge node types: domain, flow, step, article, entity, topic, claim, source
|
|
- IDs use the node type as prefix, e.g. `file:path`, `function:path:name`, `config:path`, `article:path`
|
|
- `edges[]` — each has {source, target, type, direction, weight}
|
|
- Key types: imports, contains, calls, depends_on, configures, documents, deploys, triggers, contains_flow, flow_step, related, cites
|
|
- `layers[]` — each has {id, name, description, nodeIds[]}
|
|
- `tour[]` — each has {order, title, description, nodeIds[]}
|
|
|
|
## How to Read Efficiently
|
|
|
|
1. Use Grep to search within the JSON for relevant entries BEFORE reading the full file
|
|
2. Only read sections you need — don't dump the entire graph into context
|
|
3. Node names and summaries are the most useful fields for understanding
|
|
4. Edges tell you how components connect — follow imports and calls for dependency chains
|
|
|
|
## Instructions
|
|
|
|
1. Check that `.understand-anything/knowledge-graph.json` exists. If not, tell the user to run `/understand` first.
|
|
|
|
2. **Read project metadata** — use Grep or Read with a line limit to extract the `"project"` section (name, description, languages, frameworks).
|
|
|
|
3. **Read layers** — Grep for `"layers"` to get the full layers array. These define the architecture and will structure the guide.
|
|
|
|
4. **Read the tour** — Grep for `"tour"` to get the guided walkthrough steps. These provide the recommended learning path.
|
|
|
|
5. **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`.
|
|
|
|
6. **Identify complexity hotspots** — from the file-level nodes, find those with the highest `complexity` values. These are areas new developers should approach carefully.
|
|
|
|
7. **Generate the onboarding guide** with these sections:
|
|
- **Project Overview**: name, languages, frameworks, description (from project metadata)
|
|
- **Architecture Layers**: each layer's name, description, and key files (from layers + file nodes)
|
|
- **Key Concepts**: important patterns and design decisions (from node summaries and tags)
|
|
- **Guided Tour**: step-by-step walkthrough (from the tour section)
|
|
- **File Map**: what each key file does (from file-level nodes, organized by layer)
|
|
- **Complexity Hotspots**: areas to approach carefully (from complexity values)
|
|
|
|
8. Format as clean markdown
|
|
9. Offer to save the guide to `docs/ONBOARDING.md` in the project
|
|
10. Suggest the user commit it to the repo for the team
|