whats-going-on

To create an onboarding map for a codebase, survey core files and entrypoints to outline core use cases, lifecycle, architecture, and recommended reading start points for new contributors.

Generate documentation showing repository structure by surveying core files and entrypoints to produce a one-page map. This map provides evidence-backed references to key files and docs, outlining the architecture and main components for new contributors.

The best way to outline architecture and core use cases is applying a one-pass survey to the repository. This extracts guidance from files to shape a structured, discoverable plan showing the lifecycle and main components.

Yes, you can use one-pass mapping for mid-size codebases. The approach applies to onboarding scenarios across small to mid-size codebases, outlining core use cases, lifecycle, architecture, and starting points effectively.

Generating an onboarding map parses SKILL.md frontmatter for name and description, and extracts guidance from the body to shape the artifact. This process structures the discoverable plan for the target repository.

You should not use an automated codebase mapping tool when a repository lacks clear core files or entrypoints to survey. The tool relies on parsing file structures and extracting guidance to produce evidence-backed references.