skills.rest
mor-duongmh
mor-duongmhCOMMUNITY
Explore all skills by this author →
GitHub

generate-codebase-summary

Generate a README-style codebase overview with tech stack and repository layout.

3|Updated Apr 20, 2026
Search Tags:#documentation#codebase#overview#tech-stack#repo#entry-points#loc
One-click install
npx skills add https://github.com/mor-duongmh/morkit-plugin --skill generate-codebase-summary
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-codebase-summary
Source: https://github.com/mor-duongmh/morkit-plugin/tree/main/plugins/morkit/skills/generate-codebase-summary
Command: npx skills add https://github.com/mor-duongmh/morkit-plugin --skill generate-codebase-summary

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

The Skill automates creation and maintenance of a README-style codebase overview by deriving content from a ProjectModel and repository scan.

Core Features & Use Cases

  • Generate a comprehensive codebase summary (tech stack, repo layout, packages, entry points, LOC by language) from a ProjectModel and file tree.
  • Update the summary via delta-based changes and sync scans for additions and removals.
  • Use cases include onboarding new contributors, auditing repo structure, and tracking language-level LOC.

Quick Start

Render the codebase summary for the current project model and write it to docs/codebase-summary.md

Frequently Asked Questions about generate-codebase-summary

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a codebase summary for my repository?▼

To generate a codebase summary, the Skill scans your repository and synthesizes a structured README-style overview. It automatically extracts the tech stack, repo layout, packages, entry points, and LOC by language from your file tree and manifests.

What is the best way to document a multi-language codebase?▼

Documenting a multi-language codebase is best handled by deriving content from a ProjectModel and file tree scan. This approach produces a structured overview covering tech stack, repository layout, packages, entry points, and LOC per language.

Can I update my codebase overview automatically when files change?▼

Yes, you can update your codebase overview using delta-based changes and on-demand sync scans. The Skill examines manifests and file trees to apply additions and removals without regenerating the entire summary from scratch.

Does this codebase summary tool work with monorepo structures?▼

Yes, this codebase summary tool works with both mono- and multi-language codebases. It scans the entire repository layout to map packages and entry points, producing a comprehensive overview suitable for monorepo auditing and onboarding.

Why do I need a generated codebase summary for developer onboarding?▼

A generated codebase summary accelerates developer onboarding by providing an immediate, structured view of the project. New contributors can quickly understand the tech stack, repository layout, and entry points without manually traversing the codebase.

Related Skills

Explore More Software Engineering Skills→
mor-duongmhmor-duongmh
3

generate-code-standards

Generate and update docs/code-standards.md from a ProjectModel with lint and commit rules.

Community
Intermediate
inbharataiinbharatai
22

markdown-pro

Generate, format, and convert Markdown documents for README files, wikis, and changelogs.

Community
Intermediate
superdesigndevsuperdesigndev
43

archlet

Generate interactive architecture maps and PR diff overlays from import graphs.

Official
Advanced
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic