explain-codebase

Solid

Use when you need to understand an unfamiliar repository or module and produce a structured walkthrough of how it works and where to change it.

AI & Automation 1 stars 0 forks Updated 5 days ago MIT

Install

View on GitHub

Quality Score: 78/100

Stars 20%
10
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
38
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Explain Codebase ## When to use Invoke this skill when onboarding to a codebase, investigating a subsystem, or locating where a change should be made. ## Steps 1. Map the entry points and the high-level modules from the directory layout. 2. Trace one concrete flow end to end (request, build, job) to anchor understanding. 3. Note the key abstractions, data structures, and external dependencies. 4. Identify the files most relevant to the user's question. 5. Produce a layered summary: what it does, how it works, where to start. ## Examples - "Explain how authentication works in this repo" - "Walk me through the request lifecycle" ## References Prefer file:line references and small diagrams over prose; stop before guessing behaviour you have not verified.

Details

Author
NSBen
Repository
NSBen/skillfoundry
Created
5 days ago
Last Updated
5 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

explain-codebase

Onboard to an unfamiliar codebase by mapping its architecture, entry points, and data flow. Use when starting work in a new or unknown repository and you need a navigable mental model fast.

4 Updated today
KhaledSaeed18
AI & Automation Listed

codebase-explain

Tell the agent to explain code with broader context and a higher-level perspective. Use when you're unfamiliar with a section of code or need to understand how it fits into the bigger picture.

1 Updated yesterday
risadams
Web & Frontend Listed

explain-my-code

This skill should be used when the user asks to "document this codebase", "explain my code", "generate architecture docs", "write an onboarding doc", "analyze this repo", or wants self-contained technical documentation produced from source. Signal tokens include "codebase", "repo", "architecture diagram", "onboarding", "system overview", "tech stack", ".md doc". Casual phrasings (when paired with an onboarding/documentation intent) include "help a new dev understand this whole codebase", "write up how this project works", "map out this code into a doc". Also trigger when the user points at a repository and asks for a single Markdown write-up with Mermaid diagrams. Do NOT use for a quick one-line "what does this do" answer, for line-by-line code review or bug-finding (that is wordpress-architect-review or a review skill), for refactoring or modernization plans (that is refactoring-analyst), or for producing diagrams alone (that is codebase-to-mermaid).

2 Updated 3 days ago
chrismccoy