johnkimec/scilla

walkthrough

Explain a codebase in one linear document whose code snippets were printed by a command.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/johnkimec/scilla --skill walkthrough

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

Walkthrough

Explain the code in one pass, from the start of the story to the end. A snippet typed from memory is a miss. Commentary, then a command that prints the file, then the output that command produced.

Pass

  1. Read, then plan. Read the source. Plan one order a reader can follow from beginning to end, starting at the foundation or the entry point and moving outward. If the user named a file or an area, stay inside it.
  1. Learn the tool. Run uvx showboat --help and use what it prints.
  1. Write `walkthrough.md` at the repo root. If that file already exists, ask before replacing it. Create it with uvx showboat init.
  1. Alternate notes and printed code. Commentary goes in with uvx showboat note. Every snippet is a uvx showboat exec of sed, grep, cat, find, or wc that prints the bytes on disk. A hand-copied snippet does not go in the note.
  1. Fix a bad command in the document. If an exec fails or prints the wrong lines, uvx showboat pop that entry and run the corrected command.
  1. Check. Run uvx showboat verify walkthrough.md. In the reply, give the path to the document.

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills