onboard
Installation
SKILL.md
Codebase Onboarding Generator
This skill runs in a forked subagent so the broad discovery work doesn't pollute the parent conversation's context. The parent receives a concise summary; the full analysis lives in the generated files.
Procedure
-
Analyze project structure
- Top-level layout, build tooling, language and framework versions
- Key entry points, primary modules, integration points
- Notable conventions (testing, error handling, configuration, naming)
-
Write
CODEBASE.md- Architecture overview (high-level + per-module)
- Setup and run instructions
- Key patterns to know — what's idiomatic in this repo
- Gotchas — things that surprised you while exploring
- Where to start reading (5-10 file pointers)