codebase-onboarding-skill

Automatically generate codebase onboarding documentation by triggering the skill in your project workspace to create a quick-start guide and an architecture deep-dive at the project root. It detects project metadata and structure to populate repository-relative paths and structured sections automatically.

Create an architecture deep-dive with Mermaid diagrams by running the skill to map module responsibilities, code-reading paths, and design decisions. It outputs a structured markdown file at the project root, providing a guided starting point for new team members.

Yes, you can generate a quick-start guide that includes development workflows and common pitfalls alongside repository-relative paths. The skill outputs this document at the project root to help newcomers understand unfamiliar codebases quickly.

Yes, the generated onboarding documentation automatically detects project metadata and structure. This detection populates repository-relative paths and ensures consistent formatting and coverage across the quick-start guide and architecture deep-dive outputs.

Ensure the codebase onboarding documents include module responsibilities and reading paths by verifying the skill has access to the project root. The tool automatically populates these structured sections based on detected project metadata and structure.