gezel Gezel Handboek

Explain a code folder

A plain-language tour of a folder of code: what it does, how the files are organised, how to run it, and the three files to read first. Every file and command it names comes from the folder itself. Good for a project you inherited, an open-source tool you want to understand, or your own code after a long break.

How it runs

#StepWho runs itWhat happens
1Explain the folderDeveloperRead the code and write a plain-language overview of it.
2FinishDeveloperThe deliverable passed its checks. Stamp a short summary and report DONE.

Say something like "explain a code folder" or "explain this codebase" or "what does this code do" or "overview of this repo" or "walk me through this code" in chat to start it.

Watch this article as a slideshow