用途:当用户提供本地仓库路径或远程 Git URL,并要求“教我读懂这个仓库”“简单解释这套代码库”时,Repo Tutor 会生成一份面向初学者的课程式教学产物。它强调先教学后编目,围绕一条核心用户旅程和一条开发者旅程展开,而不是逐目录罗列。
主要能力:先解析并冻结输入(记录 Git remote、提交、工作区状态,脏树或非 Git 目录需对引用文件做哈希);建立证据台账,把每条技术论断标注为 Observed(源码/配置/文档直接支持)、Inferred(由多个观察事实推断)或 Unknown(证据缺失或不可静态分析);随后产出六个固定页面:Start Here、Use It、Follow the Work、Inside the System、Build on It、Practice Lab。最终交付一个自包含的离线 HTML 文件,含哈希路由虚拟页、导航、进度、术语表、证据附录,架构与流程用 Mermaid 校验后渲染为内联 SVG,表格用语义 HTML,代码仅保留短证据片段。
使用方式:接受一个仓库来源;本地路径需确认为可读目录,远程 URL 需为 Git URL,并以浅克隆、无标签方式克隆默认分支到临时暂存区。所有中间与输出文件放在目标仓库之外,交付后清理。默认静态分析,未经明确批准不执行目标构建脚本、钩子、二进制、测试或示例代码;不修改目标仓库。
适用场景:需要把陌生代码库讲成连贯系统的教学、新人上手、理解核心工作流与责任边界。
限制:不适用于仅要架构图、仓库审计、API 参考、维护者文档或 PR 审查等请求;对不透明二进制、缺失子模块、仅生成行为、不可用服务或源码中不存在的运行时行为无法给出完整知识,需明确说明边界。若浏览器自动化不可用,须标注“未执行浏览器检查”并列出跳过项,不得声称已完成浏览器验证。