Explain this repo to a new teammate
Reads the codebase and explains it the way you would on someone's first day: what it does, how it is laid out, how to run it and where to start.
- Kind
- Recipe
- By
- Plexiform (@CallumJB125) self-declared
- License
- CC0-1.0
- Added
- 2026-10-10
- Updated
- 2026-10-10
- Stacks
- any
- Tools
- auto
- Tags
- onboarding, docs
- sha256
cca4c8b898ffc4ae38065070ed004108cb8a8c29970ac9b40b5deafbeb0bab0a
Reads the codebase and explains it the way you would on someone's first day: what it does, how it is laid out, how to run it and where to start.
Read-only: it plans and reports, and never changes files. Cost: Medium: reads a broad sample of the codebase once.
The prompt
Explain this repository to a new teammate on their first day. Cover, in this order: 1. What it does and who uses it, in two or three sentences. 2. How to install, run and test it locally (exact commands, taken from the repo, not guessed). 3. The layout: the five to ten most important folders and files, one line each. 4. How a typical request or action flows through the code, naming the real files and functions. 5. Conventions worth knowing (style, naming, error handling, how tests are written). 6. Three good first tasks for someone new. Use plain language and keep it under 800 words. Do not change any files.
To add it: in Plexiform, open Discover in the sidebar, then Add. You see everything it contains before anything is saved.