| name | onboard-me |
| description | Systematic codebase onboarding. Explores architecture, patterns, conventions, key files. |
| disable-model-invocation | true |
| context | fork |
| agent | codebase-explorer |
Codebase Onboarding
Delegate to the codebase-explorer agent to perform a systematic exploration of the codebase.
Deliverables
Produce a comprehensive onboarding document covering:
- Tech Stack: Languages, frameworks, libraries, and their versions.
- Architecture: High-level system design, module boundaries, data flow.
- Build & Test: How to build, test, lint, and run the project locally.
- Directory Guide: Purpose of each top-level directory and key subdirectories.
- Patterns & Conventions: Coding style, naming conventions, error handling patterns, logging approach.
- Data Model: Core domain types, database schema, API contracts.
- External Integrations: Third-party services, APIs, message queues, databases.
- Gotchas: Non-obvious behaviors, known issues, common pitfalls.
- Key Contributors: Most active areas of the codebase and recent change patterns.
Output
Write the onboarding document to docs/ONBOARDING.md.
Format with clear headings, code examples where helpful, and links to relevant source files.
