Index of every page on this site: llms.txt
All skills
egonex-ai avatar

/understand-onboard

@bb70fdb
by EgonexAIegonex-ai/understand-anything93k stars
7,959
Run it yourself

Use when you need to generate an onboarding guide for new team members joining a project

Requires /understand
Use this Skill: https://skilld.dev/gh/egonex-ai/understand-anything/understand-onboard

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈27 tokens for metadata: the name and description. ≈1.2k when used: this file.

Description uses 1.4% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈109 characters, or 1.4%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

/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. Resolve the data directory $UA_DIR. Run UA_DIR=$([ -d .understand-anything ] && echo .understand-anything || echo .ua) — this is the legacy .understand-anything/ when it already exists, otherwise the new .ua/. Check that $UA_DIR/knowledge-graph.json exists. If not, tell the user to run /understand first.

  2. Check graph freshness before using graph-derived context:

    • Read project.gitCommitHash from the graph metadata as GRAPH_COMMIT_RAW. Resolve it as a commit before using it in any Git diff, then compare it with git rev-parse HEAD and inspect project-scoped committed and working-tree changes from the project root:
      GRAPH_COMMIT=$(git rev-parse --verify --end-of-options "${GRAPH_COMMIT_RAW}^{commit}" 2>/dev/null)
      git rev-parse HEAD
      git diff --name-only "$GRAPH_COMMIT" HEAD -- .
      git diff --cached --name-only -- .
      git diff --name-only -- .
      git ls-files --others --exclude-standard -- .
    • The -- . pathspec is required: commits that only touch a sibling monorepo project must not make this graph stale. A hash mismatch alone is not stale when the project diff is empty.
    • Ignore the selected data directory (.ua/ or legacy .understand-anything/) in every command's output because it contains generated graph artifacts, not project source drift.
    • If the committed diff or any working-tree command reports project files, warn before generating the guide that onboarding content may omit those changes. Suggest: Run /understand to refresh the graph.
    • Run the commit diff only when GRAPH_COMMIT_RAW resolves successfully. If the graph commit or Git metadata is missing, invalid, or unavailable, give a brief best-effort warning and continue instead of blocking.
  3. Read project metadata — use Grep or Read with a line limit to extract the "project" section (name, description, languages, frameworks).

  4. Read layers — Grep for "layers" to get the full layers array. These define the architecture and will structure the guide.

  5. Read the tour — Grep for "tour" to get the guided walkthrough steps. These provide the recommended learning path.

  6. 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.

  7. Identify complexity hotspots — from the file-level nodes, find those with the highest complexity values. These are areas new developers should approach carefully.

  8. 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)
  9. Format as clean markdown

  10. Offer to save the guide to docs/UA_ONBOARDING.md in the project

  11. Suggest the user commit it to the repo for the team

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts3mo3 checks · Risk SAFE
  • Gen Agent Trust Hub3mo

    This skill facilitates generating onboarding documentation by analyzing a local knowledge graph file and project metadata. It uses standard shell commands to check git status and search files.

  • Socket3mo

    No alerts

  • Snyk3mo

    Risk: LOW · No issues

Signed by skilld at bb70fdb. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 3 months ago

README badge

README badge for egonex-ai/understand-anything/understand-onboard