skills.rest
Hohlas
HohlasCOMMUNITY
Explore all skills by this author →
Website𝕏@Hohla2010GitHub

generate-module-index

Regenerate MODULE_INDEX.md by extracting headers from Python, mqh, and ipynb files.

3|Updated Jun 3, 2022
Search Tags:#automation#documentation#codebase#generation#headers#module-index
One-click install
npx skills add https://github.com/Hohlas/SoSimple --skill generate-module-index
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-module-index
Source: https://github.com/Hohlas/SoSimple/tree/main/.kilocode/skills/generate-module-index
Command: npx skills add https://github.com/Hohlas/SoSimple --skill generate-module-index

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

MODULE_INDEX.md can drift out of sync with the actual headers across code files. This Skill regenerates the index automatically to ensure alignment with the project sources.

Core Features & Use Cases

  • Scan Python (.py), MATLAB-like (.mqh), and Jupyter Notebook (.ipynb) files to collect file headers.
  • Parse sections: Назначение, Входные данные, Выходные данные, Зависимости, to construct MODULE_INDEX.md.
  • Generate MODULE_INDEX.md and show a diff for review before applying changes.
  • Useful after bulk changes or when MODULE_INDEX.md has fallen out of sync.

Quick Start

Run the command to rebuild MODULE_INDEX.md from file headers in the project.

Frequently Asked Questions about generate-module-index

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

FAQPage Schema
How do I regenerate a module index from file headers in a multi-file codebase?▼

To generate MODULE_INDEX.md, the Skill scans Python, mqh, and ipynb files to extract file headers and parse sections like Назначение, Входные данные, Выходные данные, and Зависимости. It compiles these extracted headers into a centralized, consistent index file for your codebase.

Why does my MODULE_INDEX.md drift out of sync with source file headers?▼

MODULE_INDEX.md drifts out of sync when source code headers are updated during development but the central index is not manually maintained. This Skill regenerates the index automatically by scanning Python, mqh, and ipynb files to ensure alignment with actual project sources.

Can I use this to extract headers from Jupyter Notebook and Python files?▼

Yes, you can extract headers from Jupyter Notebook (ipynb), Python (py), and MATLAB-like (mqh) files. The Skill scans these multi-file codebase formats to collect file headers and parse specific documentation sections for MODULE_INDEX.md generation.

Does generating MODULE_INDEX.md show a diff before applying changes?▼

Yes, generating MODULE_INDEX.md presents a diff for review before applying changes. This allows you to confirm the extracted header sections and parsed content are correct before the centralized index file is updated.

What is the best way to document codebase dependencies and module purposes automatically?▼

The best way to document codebase dependencies and module purposes automatically is to parse file header sections like Назначение and Зависимости from source files. This compiles standardized documentation into a centralized MODULE_INDEX.md.

Related Skills

Explore More Content & Communication Skills→
MicrockMicrock
322

exploratory-data-analysis

Analyze scientific data files and generate detailed Markdown reports.

Community
Intermediate
jbottjbott
1

jj:commit

Create a jj commit with a description generated from diff summary and stat.

Community
Intermediate
ayazhankadessovaayazhankadessova

move-a-file

Move or rename files with `git mv` and update all codebase references.

Community
Advanced
GDSDNGDSDN
3

shard-doc

Splits large markdown documents into files by level 2 headings.

Community
Advanced