Skills
.Work. You
Rest

submodule-overview

Community

Turn submodule structures into clear docs.

Software Engineering#documentation#markdown#metadata#overview#analyze#submodule#project-structure
AuthorNagasakaH
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Analyzes a submodule directory to generate a structured overview document by extracting information from README.md, CLAUDE.md, and AGENTS.md, then consolidates directory structure and metadata.

Core Features & Use Cases

  • Project structure: captures directory layout and main files.
  • Public interfaces: identifies exported APIs or entry points from common meta files.
  • Build/Test guidance: surfaces test and build commands when present.
  • Documentation generation: outputs submodules/<folder-name>.md with a concise summary.
  • Use Case: generate an up-to-date overview for onboarding a new submodule.

Quick Start

Provide the submodule path to the skill to generate the overview document.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: submodule-overview
Download link: https://github.com/NagasakaH/dev-process/archive/main.zip#submodule-overview

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.