johnkimec/scilla

walkthrough

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

Vedi sorgente

Come usare

  1. Copia il comando e controlla il pacchetto prima di installarlo nel tuo ambiente agente.
  2. Controlla strumenti, credenziali e ambienti richiesti nel documento originale.
  3. Descrivi input e risultato desiderato; confronta l’output con le fonti.
npx skills add https://github.com/johnkimec/scilla --skill walkthrough

Prima di iniziare

  • L’installazione non include abbonamenti, quote API o accesso ai file.
  • Stelle e installazioni indicano attività, non un test indipendente di qualità o sicurezza.
Documento Skill originale

Contenuto dal repository con titoli, esempi, codice, tabelle, link e immagini preservati.

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.

Correlati per attività

dallo stesso repository

Altri Skills

Tutti gli Skills