doc-updater

Generate codemaps and READMEs from codebases while validating file existence and link integrity.

24|5|Updated Feb 8, 2026

Search Tags:#automation #documentation #documentation-generation #codebase-analysis #readmes #codemaps

Ready to run

npx skills add https://github.com/Luohaothu/everything-codex --skill doc-updater-luohaothu

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-updater
Source: https://github.com/Luohaothu/everything-codex/tree/main/skills/doc-updater
Command: npx skills add https://github.com/Luohaothu/everything-codex --skill doc-updater-luohaothu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift between code and docs is common; this skill generates codemaps and READMEs directly from the codebase to keep documentation aligned.

Core Features & Use Cases

Automated codemaps derived from repository structure, entry points, and dependencies.
README and guide generation from live code, ensuring up-to-date references.
Use Case: When onboarding a new developer, run this skill to produce a current codemap and overview docs for the repository.

Quick Start

Run doc-updater on your repository to generate fresh codemaps and updated READMEs from the codebase.

Frequently Asked Questions about doc-updater

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

FAQPage Schema

How do I keep documentation in sync with my codebase automatically?▼

To keep documentation in sync, you can generate codemaps and READMEs directly from your codebase. This skill automates that process by mapping repository structures, entry points, and API routes to ensure docs stay aligned with live code.

What is a codemap and how does it help with codebase analysis?▼

A codemap is a structural map of a repository's architecture, entry points, and dependencies. It helps with codebase analysis by providing developers a clear overview of data models and API routes, which is especially useful during onboarding.

How do I generate up-to-date READMEs and guides from live code?▼

Generating up-to-date READMEs from live code requires analyzing the repository structure and dependencies. This skill automates that extraction, applying freshness timestamps and validating file existence to ensure all references remain accurate.

Are there limitations to automated codebase documentation generation?▼

Limitations of automated documentation generation include strict file constraints: codemaps must stay under 500 lines to remain effective. The process also enforces freshness timestamps and validates link integrity to prevent documentation drift.

Does this documentation generation approach work for multiple repositories?▼

Yes, this documentation generation approach applies across multiple projects. It consistently maps repository structures, data models, and API routes while enforcing freshness timestamps and file existence validation for each codebase.