skills.rest
roeeyn
roeeynCOMMUNITY
Explore all skills by this author →
Website𝕏@roeeynGitHub

create-codetour-tour

Create ordered Codetour JSON tours with 3–7 stops for codebase flows.

1|Updated May 11, 2026
Search Tags:#workflow#documentation#json#neovim#code-flow#tour#codetour
One-click install
npx skills add https://github.com/roeeyn/codetour.nvim --skill create-codetour-tour
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-codetour-tour
Source: https://github.com/roeeyn/codetour.nvim/tree/main/.claude/skills/create-codetour-tour
Command: npx skills add https://github.com/roeeyn/codetour.nvim --skill create-codetour-tour

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Codetour tours help developers document the execution path in a codebase by creating named, ordered stops that guide exploration and persist navigation state.

Core Features & Use Cases

  • Create and amend named tours with 3–7 stops that illustrate the flow from entry to dispatch through to results.
  • Persist tours as JSON at <repo>/.codetour/<tour-name>.json and navigate stops with Neovim's quickfix list.
  • Validate and annotate stops with a short note explaining why each stop matters, plus a live context line to anchor positions.

Quick Start

Prompt the assistant with a description of the flow you want to document, and it will generate a tour JSON file ready to walk in Neovim.

Frequently Asked Questions about create-codetour-tour

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

FAQPage Schema
How do I create a code tour in Neovim to document an execution flow?▼

To create a code tour in Neovim, prompt the assistant with your target flow to generate an on-disk JSON tour file at <repo>/.codetour/ containing 3–7 ordered stops with notes explaining why each matters.

What is a codetour and how does it help document a codebase?▼

A codetour documents a codebase's execution path by creating named, ordered stops that guide exploration, explain code flow from entry to exit, and persist navigation state as JSON.

How do I structure JSON for codetour version 2 tours?▼

Codetour version 2 JSON requires unique stop IDs, relative file paths, correct 1-indexed lnum and 0-indexed column values, and a literal context line captured from the target source file.

Can I use codetour to trace authentication flows and feature pipelines?▼

Yes, codetour is designed for scenarios like documenting auth flows or feature pipelines by assembling an ordered tour of stops that illustrates how the codebase flows from entry to dispatch through to results.

Does codetour require a specific Neovim setup to navigate tour stops?▼

Codetour persists tours as JSON files and allows you to navigate the stops using Neovim's built-in quickfix list, requiring no additional dependencies or components.

How many stops should a codetour contain to explain a code flow effectively?▼

A codetour should contain 3–7 stops in execution order, with each stop annotated with a short note and a live context line to anchor positions and explain why the stop matters.

Related Skills

Explore More Software Engineering Skills→
JacksonhufJacksonhuf

copaw_source_index

Map user question topics to CoPaw documentation and source entry paths.

Community
Intermediate
vrcmsvrcms
1

code-tour

Generate structured CodeTour JSON artifacts anchored to file paths and line ranges.

Community
Intermediate
WarrenZhu050413WarrenZhu050413
7

Writing Lua

Structure Neovim Lua plugins with modularity and LuaCATS type annotations.

Community
Advanced
kryptobaseddevkryptobaseddev
160

ct-docs-review

Review Markdown documentation for CLEO style compliance with inline comments.

Community
Basic