code-tour

Create a guided walkthrough by generating structured CodeTour JSON artifacts that anchor narrative steps to specific file paths and line ranges. This replaces static documentation with interactive, step-by-step codebase tours for new engineers.

The best way to document code changes is by creating a codebase tour that anchors narrative steps to precise file paths and modified lines. This generates an interactive walkthrough tailored for PR reviewers examining specific logic paths.

Yes, you can tailor codebase tours for different reviewer personas. The generated CodeTour JSON adjusts the depth and focus of the narrative based on the target reader, such as a security reviewer, architect, or new joiner.

Map narrative steps to specific code locations by defining precise file paths and line ranges within the CodeTour JSON. This contextual anchoring ensures your architecture walkthrough remains accurate and directly linked to the real source files.

Generating a CodeTour requires no external dependencies or component installations. The skill operates independently to produce structured JSON artifacts, provided you supply the precise file and line mappings for the target codebase.

A codebase tour loses accuracy when narrative steps lack precise file and line mapping. To ensure the generated tour remains actionable and correct during RCA investigations or walkthroughs, anchor every step to exact code locations.