← 返回
未分类 中文

Repo Tour

Turn a codebase into a self-contained interactive HTML course for onboarding, walkthroughs, or stakeholder explanation.
将代码库转换为独立的交互式HTML课程,用于入职培训、演示或向利益相关者解释。
leostehlik leostehlik 来源
未分类 clawhub v0.2.1 3 版本 100000 Key: 无需
★ 0
Stars
📥 376
下载
💾 0
安装
3
版本
#codebase#docs#latest#onboarding#openclaw

概述

Code Decoded

Turn a codebase into a self-contained interactive HTML course. One file. No setup. Host it, share it, or open it locally.

Read references/html-structure.md for the HTML output spec.

Read references/design-principles.md for visual and content rules.

Activation and Data Boundary

Use this skill only when the user explicitly asks for Code Decoded, a repo tour, onboarding course, codebase walkthrough, or stakeholder explanation. Do not activate it for routine code review, refactoring, or debugging.

The skill reads repository files and writes one HTML output file. Confirm or choose an output path before writing, and do not overwrite an existing file without user approval. Generated HTML can contain real source snippets, internal file paths, and architecture details; review it before sharing outside the project.

What to Build

A single HTML file that teaches how the codebase works through:

  • Scroll-based modules — one concept per section, progress indicator
  • Code + plain English side by side — real code from the repo on the left, what it means on the right. Never modify or simplify the code.
  • Architecture overview — visual diagram of how the main components connect
  • Data flow walkthrough — trace what happens during a key user action (login, submit, search — whatever is most representative)
  • Interactive quizzes — application-focused, not memorization. "A user reports stale data after switching pages. Where would you look first?" Not "What does API stand for?"
  • Glossary tooltips — hover any technical term for a plain-English definition
  • Keyboard navigation — arrow keys to move between sections

Before Starting

Ask the user (or infer from context):

  1. Audience — non-technical (product users, stakeholders), developer onboarding, or power users?
  2. Focus — full codebase tour, or a specific area (auth, data layer, a specific feature)?
  3. Key action to trace — what is the most important thing the code does? This becomes the data flow module.

If the user says "just do it" — infer from the codebase and proceed.

How to Generate

  1. Read the codebase structure (directory tree, key files)
  2. Identify: entry points, main modules, data models, key user flows
  3. Pick 5-8 concepts to teach — ordered from "what is this?" to "how does it work?" to "how do I use/change it?"
  4. Write the HTML course following references/html-structure.md and references/design-principles.md
  5. Output as a single .html file

Output

Name the file: [repo-name]-tour.html

It must:

  • Work offline (no external CDN, no network requests)
  • Be self-contained (all CSS and JS inline)
  • Render correctly in Chrome, Firefox, Safari
  • Be hostable as a static page with no build step

版本历史

共 3 个版本

  • v0.2.1 当前
    2026-05-25 17:04 安全 安全
  • v0.2.0
    2026-05-23 23:29 安全 安全
  • v0.1.0
    2026-05-21 15:46 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

ai-agent

Better Every Run

leostehlik
每次运行更好:将显式 /ber 纠正转化为理想结果,包含小修复、记忆与报告流程。
★ 1 📥 622
education

Language Learning Tutor

chipagosfinest
AI语言导师,通过对话、词汇练习、语法课程、抽认卡及沉浸式练习,助您学习任意语言。适用于学习新语言、练词汇、学语法、翻译、会话练习、旅行准备、习语俚语或改善发音。支持包括中、英、日、韩、法、德、西等在内的100多种语言。
★ 29 📥 8,883
education

Interview Simulator

wscats
模拟各类职位和经验水平的面试,提供定制化的技术、行为及案例问题,并给予详细反馈与评分。
★ 23 📥 22,006