code-tour

Generate VS Code CodeTour .tour walkthroughs with persona-specific steps and validation.

3|1|Updated Apr 12, 2026
One-click install
npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill code-tour-cogni-ai-ou
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-tour
Source: https://github.com/Cogni-AI-OU/cogni-ai-agent-skills/tree/main/code-tour
Command: npx skills add https://github.com/Cogni-AI-OU/cogni-ai-agent-skills --skill code-tour-cogni-ai-ou

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

CodeTour helps you create reliable, persona-targeted walkthroughs that navigate directly to real files and line numbers, so onboarding and feature tours don’t drift or break.

Core Features & Use Cases

  • Create CodeTour .tour files: Produce .tour walkthroughs for onboarding, architecture explanations, and subsystem deep dives that work with the VS Code CodeTour extension.
  • Generate from existing docs: Start with a README/docs skeleton and then fill in each TODO with descriptions matched to the target persona.
  • Validate before use: Use bundled scripts to verify JSON validity, ensure referenced paths exist, check line bounds, and confirm narrative arc and cross-references.

Quick Start

Use the code-tour skill to create a tour file skeleton by running: python ~/.agents/skills/code-tour/scripts/generate_from_docs.py --persona new-joiner --output .tours/skeleton.tour.

Frequently Asked Questions about code-tour

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate CodeTour walkthroughs for onboarding new developers?▼

CodeTour .tour files are JSON walkthroughs that link persona-specific steps to real repository files and stable anchors. They work with the VS Code CodeTour extension to provide structured onboarding and architecture walkthroughs.

How do I create a code walkthrough from existing repository documentation?▼

You can generate a .tour skeleton from existing README or docs files using the bundled Python script. It produces a walkthrough file with TODO placeholders that you fill with persona-specific descriptions for your code walkthrough.

Can I validate CodeTour JSON files to ensure referenced paths and line numbers exist?▼

Yes, bundled scripts validate the CodeTour JSON schema, ensuring referenced paths exist, checking line bounds, and confirming cross-references. This prevents broken walkthroughs before you use them for onboarding.

Do CodeTour walkthroughs support specific personas for repository navigation?▼

Yes, CodeTour walkthroughs support persona-specific steps for repository navigation. You can generate tours targeting specific audiences like new-joiners by matching narrative arcs and descriptions to the intended role.

What is the best way to ensure my VS Code CodeTour files do not break during development?▼

The best way to prevent broken CodeTour files is to run the bundled validation scripts. They verify schema constraints, check path existence, validate line bounds, and confirm cross-references against your repository.