Home / milad-ahmd / agent-skills · GitHub

codebase-explainer SKILL.md skillF

codebase-explainer from milad-ahmd/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add milad-ahmd/agent-skills/codebase-explainer@git:20261025.7c7d700

Pins git:20261025.7c7d700 in mdr.lock. Pin the fingerprint instead.

Audit grade: F, 16 of 17 checks passed
Kind: SKILL.md skill
Repository: milad-ahmd/agent-skills
Path: skills/codebase-explainer/SKILL.md
Versions recorded: 1
Latest version: git:20261025.7c7d700, committed Oct 25, 2026
Size: 2,153 bytes
Repository stars: 5
License: MIT

Produces an onboarding guide for an unfamiliar repository with an architecture overview, Mermaid diagrams, entry points, data flow, key modules, and the "dangerous" files to touch carefully. Use when the user asks to explain a codebase, onboard to a repo, map the architecture, or "where do I start?".

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Codebase Explainer

Turn "I just cloned this and I'm lost" into "I know where everything lives" in 10 minutes.

## 1. Explore (breadth first, read-only)

- Folder tree (2–3 levels, ignoring `node_modules`, `.git`, `dist`, `vendor`, `.venv`).
- Manifests, README, docs, CI workflows, Dockerfiles, env examples.
- **Entry points**: `main`, `index`, `app`, `server`, CLI bins, route definitions, `cmd/`, mobile `App`/`main.dart`.
- Data layer: ORM models, schema or migrations, API clients.
- Hotspots: `git log --since=1.year --name-only --pretty=format: | sort | uniq -c | sort -rn | head -20`.

## 2. Write `ARCHITECTURE.md` (or show it inline if the user prefers)

```markdown
# Architecture of <project>

## TL;DR
3 sentences: what it does, main tech, how it's deployed.

## Map
| Path | Responsibility |

## How a request flows
```mermaid
sequenceDiagram
  Client->>API: POST /orders
  API->>Service: createOrder()
  Service->>DB: insert
```

## Components
```mermaid
flowchart LR
  web[Web app] --> api[API] --> db[(Postgres)]
```

## Key concepts & glossary
Domain terms and what they mean in code.

## ⚠️ Handle with care
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add milad-ahmd/agent-skills/codebase-explainer@sha256:14245613d587acd2

The line at the top of this page pins the label git:20261025.7c7d700, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

[![mdr](https://markdownregistry.com/badge/art_6gk4snsxe73p2mpr.svg)](https://markdownregistry.com/a/art_6gk4snsxe73p2mpr)

3 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Oct 25, 2026.

version	committed	commit	size	audit
git:20261025.7c7d700 latest	2026-10-25	7c7d700	2,153 B	F	view

Audit of the latest version

F 16 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

FAIL, critical: No zero-width or bidi control characters (matched: )
pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (2153 bytes)
pass: No instruction hidden inside an HTML comment
pass: No link to an exfiltration or paste host
pass: No credential-shaped string
pass: No instruction to send local credentials anywhere
pass: No text hidden with inline styles
pass: No prompt-injection phrasing
pass: No curl or wget piped into a shell
pass: No recursive delete of root, home or parent
pass: No instruction to read or print local credentials
pass: No base64 blob over 200 characters
pass: No link to a raw IP address
pass: No script tag

Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

milad-ahmd/agent-skills · 5 stars · license MIT · pushed 2026-10-29 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_6gk4snsxe73p2mpr
GET https://markdownregistry.com/api/v1/resolve?ref=milad-ahmd/agent-skills/codebase-explainer
GET https://markdownregistry.com/api/v1/blob/14245613d587acd20e31a4b64847482f753bd98b65040cc29f8b4058180965a1

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.