code-tour

Generate code walkthrough artifacts by creating a CodeTour JSON file that orients readers to the codebase root, maps core modules, and anchors steps to specific files and line numbers. This provides a self-contained narrative arc for new-joiner ramp-up.

Document codebase architecture by building a multi-step CodeTour that anchors to specific files, lines, or patterns, linking to real files and resources. The tour enforces a narrative arc of orientation, a high-level map, core path steps, and closing content.

Yes, you can use generated CodeTour artifacts for PR reviews and RCA investigations. The tour provides a coherent narrative linking to concrete file references, enabling reviewers to follow the logical path through the codebase changes.

Generating a CodeTour is applicable to codebases of varying sizes. It builds an orientation step pointing to the codebase root and folders, followed by core path steps that map core modules, scaling the narrative to fit the project scope.

Validate relative paths and frontmatter by enforcing the CodeTour narrative structure during generation. The process checks frontmatter, relative paths, and optional components like scripts, references, and assets to ensure links point to real files.

A CodeTour is a self-contained artifact that guides readers through a codebase using an orientation, high-level map, core path steps, and a closing summary. You need it when sharing a coherent narrative for onboarding, architecture walkthroughs, or code reviews.