Files
awesome-copilot/skills/code-tour/references/codetour-schema.json
Srinivas Vaddi 09049e3b78 feat: add code-tour skill — AI-generated CodeTour walkthroughs (#1277)
* feat: add code-tour skill for AI-generated CodeTour walkthroughs

* fix: trim SKILL.md from 645 to 432 lines (under 500 limit)

Reduce persona table to top 10, condense verbose examples and notes,
trim redundant anti-patterns, compress step type docs and PR recipe.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

* fix: run npm run build to update README with code-tour skill

Addresses review feedback from @aaronpowell

* fix: add missing scripts/ and references/ files referenced in SKILL.md

Addresses reviewer feedback — SKILL.md referenced bundled files
(validate_tour.py, generate_from_docs.py, codetour-schema.json,
examples.md) that were not included in the PR.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: run npm run build to update skills README with new assets

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-13 09:52:59 +10:00

116 lines
4.3 KiB
JSON

{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Schema for CodeTour tour files",
"type": "object",
"required": ["title", "steps"],
"properties": {
"title": {
"type": "string",
"description": "Specifies the title of the code tour."
},
"description": {
"type": "string",
"description": "Specifies an optional description for the code tour."
},
"ref": {
"type": "string",
"description": "Indicates the git ref (branch/commit/tag) that this tour associate with."
},
"isPrimary": {
"type": "boolean",
"description": "Specifies whether the tour represents the primary tour for this codebase."
},
"nextTour": {
"type": "string",
"description": "Specifies the title of the tour that is meant to follow this tour."
},
"stepMarker": {
"type": "string",
"description": "Specifies the marker that indicates a line of code represents a step for this tour."
},
"when": {
"type": "string",
"description": "Specifies the condition (JavaScript expression) that must be met before this tour is shown."
},
"steps": {
"type": "array",
"description": "Specifies the list of steps that are included in the code tour.",
"default": [],
"items": {
"type": "object",
"required": ["description"],
"properties": {
"title": {
"type": "string",
"description": "An optional title for the step."
},
"description": {
"type": "string",
"description": "Description of the step. Supports markdown."
},
"file": {
"type": "string",
"description": "File path (relative to the workspace root) that the step is associated with."
},
"directory": {
"type": "string",
"description": "Directory path (relative to the workspace root) that the step is associated with."
},
"uri": {
"type": "string",
"description": "Absolute URI (https://...) associated with the step. Use for PRs, issues, docs, ADRs."
},
"line": {
"type": "number",
"description": "Line number (1-based) that the step is associated with."
},
"pattern": {
"type": "string",
"description": "Regex to associate the step with a line by content instead of line number. Useful when line numbers shift frequently."
},
"selection": {
"type": "object",
"required": ["start", "end"],
"description": "Text selection range associated with the step. Use when a block of code (not a single line) is the point.",
"properties": {
"start": {
"type": "object",
"required": ["line", "character"],
"properties": {
"line": { "type": "number", "description": "Line number (1-based) where the selection starts." },
"character": { "type": "number", "description": "Column number (1-based) where the selection starts." }
}
},
"end": {
"type": "object",
"required": ["line", "character"],
"properties": {
"line": { "type": "number", "description": "Line number (1-based) where the selection ends." },
"character": { "type": "number", "description": "Column number (1-based) where the selection ends." }
}
}
}
},
"view": {
"type": "string",
"description": "VS Code view ID to auto-focus when navigating to this step (e.g. 'terminal', 'explorer', 'problems', 'scm')."
},
"commands": {
"type": "array",
"description": "VS Code command URIs to execute when this step is navigated to.",
"default": [],
"items": { "type": "string" },
"examples": [
["editor.action.goToDeclaration"],
["workbench.action.terminal.focus"],
["editor.action.showHover"],
["references-view.findReferences"],
["workbench.action.tasks.runTask"]
]
}
}
}
}
}
}