core-codebase-onboarding

Solid

Structured codebase orientation workflow for {{PROJECT_NAME}}. Produces an actionable mental map — entry points, dependency graph, architectural layers, hot-path identification, and a recommended reading order — before any modification work begins. Invoked via the /onboard <path> slash command or directly by any agent that must reason about an unfamiliar codebase.

AI & Automation 3 stars 0 forks Updated today MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
20
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Codebase Onboarding A structured orientation beats wandering. Every minute spent mapping the codebase pays back ten minutes in informed editing. Without a map, agents wander depth-first, accumulate false assumptions, and make changes that ripple through layers they never read. This skill gives you the map before the territory. --- ## What This Skill Is (and isn't) **Is:** Doctrine for the orientation agent spawned by `/onboard <path>`. It prescribes a phase-ordered workflow that produces a finite, actionable orientation report. The agent follows the phases in order, applies the hard rules throughout, and delivers the output contract at the end. **Is not:** - A debugging skill (see `core/observability-and-ops`) - A code-review skill (see `core/code-review-checklist`) - A refactoring plan — orientation produces a MAP, not a change list - A substitute for reading the actual code — the report is a navigation aid, not a summary that absolves the agent from reading files it will edit **Paired with:** `/onboard` slash command (`.claude/commands/onboard.md`), which is the user-facing trigger. The slash command spawns this agent; this skill loads the doctrine. --- ## Phase Sequence Execute phases **in order**. Do not skip phases. Do not start Phase N+1 while Phase N is incomplete. Each phase has a goal and produces a named output that feeds the next phase. ### Phase 0 — Governance context (goal: know the project's own rules) Before reading any source code, read the pro...

Details

Author
Canhada-Labs
Repository
Canhada-Labs/ceo-orchestration
Created
4 weeks ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Listed

codebase-onboarding

Generates a single, deeply researched ONBOARDING.md at the root of an open source (or internal) codebase, written for a brand-new contributor. Use this whenever someone wants to understand, explore, ramp up on, or document an unfamiliar repository — trigger phrases include "help me understand this codebase," "explain this repo," "onboard me to this project," "I just cloned this and I'm lost," "write an ONBOARDING.md," "what's the architecture here," "how is this repo organized," or any request to explain a project's purpose, tech stack, dependencies, architecture, or module layout. Also use it proactively whenever a user opens or references a repository they haven't worked in before and asks broad "what is this / how does this work" questions. Do NOT use this for narrow single-file explanations, API reference generation, or README-writing for a project the user is authoring themselves (that's promotional copy, not onboarding).

4 Updated today
kaizakin
Code & Development Listed

codebase-onboarding-map

Produce an accurate orientation guide to an unfamiliar codebase — how a request flows end to end, where the real rules live, what the traps are, and what to read first — grounded in the code rather than the README. Use when joining a project, inheriting a repo, returning to old code, or onboarding someone else.

0 Updated today
sriptcollector
AI & Automation Solid

project-onboarding

Scan an unfamiliar codebase, generate CLAUDE.md + OVERVIEW.md, and capture domain knowledge that code alone can't tell you. This skill should be used when the user wants to understand a new project, onboard onto a codebase, set up project documentation, create or update CLAUDE.md, or map project architecture. Common triggers include "what does this project do", "help me get started", "I just joined this repo", "document this codebase", "set up dev docs". Also applies when working on any unfamiliar or inherited project, even without an explicit onboarding request — if the user seems lost in a new codebase, this skill can help.

3 Updated yesterday
Wubabalala