Add code-tour AI walkthrough generation cursor rules

[vaddisrinivas]

Summary

• Adds .cursorrules for code-tour — an open-source (MIT) AI-powered CodeTour walkthrough generator
• Rules cover audience targeting, step planning, narrative flow, and .tour file generation
• Entry added alphabetically in the Documentation section

Details

code-tour generates CodeTour .tour files — persona-targeted, step-by-step codebase walkthroughs that link to real files and line numbers. Compatible with the VS Code CodeTour extension. The cursor rules guide AI assistants through planning and generating effective code tours.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation

  • Updated README with reference to new Cursor rules for CodeTour generation

• Chores

  • Added configuration file enabling generation of step-by-step code walkthroughs with file references and line-number annotations

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7912e930-9734-446a-9abb-35c2f7860569

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and 804b645.

📒 Files selected for processing (2)

• README.md
• rules/code-tour-ai-walkthrough-cursorrules-prompt-file/.cursorrules

---

📝 Walkthrough

Walkthrough

The pull request adds documentation and a new .cursorrules configuration file to establish a standardized workflow for generating CodeTour walkthrough files. The README is updated with a link to the new Cursor rules file, which defines the process and schema for creating persona-targeted, step-by-step .tour JSON files tied to real code locations.

Changes

Cohort / File(s)	Summary
Documentation Link README.md	Added reference to new .cursorrules file for CodeTour generation in Documentation section.
CodeTour Configuration rules/code-tour-ai-walkthrough-cursorrules-prompt-file/.cursorrules	New configuration file defining workflow for generating CodeTour .tour JSON files, including audience identification, route planning, annotation with file paths/line numbers, narrative flow guidelines, schema format, best practices (5–15 steps, entry point starts), and example CLI commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• PatrickJS

Poem

🐰 A tour through code, step by step we go,
With cursors dancing where the logic flows,
From entry points to functions deep and clear,
Each line numbered, the path sincere,
CodeTour magic, narratives take flight! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding cursor rules for code-tour AI walkthrough generation. It is specific, concise, and directly reflects the content of both modified files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}