bs-onboarding

What problem does it solve?

Orchestrates a structured onboarding process for an existing repository by mapping code modules, auditing dependencies, and producing developer-facing documentation so new contributors can become productive quickly and teams can assess technical debt and risks.

Core Features & Use Cases

• Codebase mapping: identifies modules, data and control flows, hotspots, and a domain glossary to reduce time-to-context for new engineers.
• Dependency auditing: inventories runtime and dev dependencies, highlights security and maintainability risks, and recommends quick wins.
• Developer documentation & handoff: generates developer-first README, local setup instructions, runbooks, and documents ADRs; optionally triages bugs and produces refactor plans for safe incremental improvements.
• Use Case: onboarding a developer to a legacy service to prepare a sprint for refactoring and risk mitigation.

Quick Start

Run bs-onboarding against the target repository path to generate a codebase-map, dependency-audit, and developer-docs and optionally include bug-triage and refactor-plan files.