Generating Docs

telagod/code-abyss

This generates README and DESIGN scaffolds for new modules by analyzing directory structure, dependencies, and code signatures. It's automatic, not user-invoked, so it runs right after module creation to give you templates while decisions are fresh. The Python support is strongest (pulls docstrings, class signatures), while other languages get directory trees and dependency lists. The key insight here is brutally honest: it fills the easy parts like module names and file lists, but leaves TODO placeholders for everything that matters, like why you made specific design choices or what you deliberately chose not to build. The source is clear that leaving those TODOs unfilled past a day means you'll forget the reasoning and documentation quality tanks. Supports a force flag but warns against using it if humans have already written content.

GitHub stars

224

last updated

Jun 10, 2026

doc_generator.js 生成骨架
        ↓
人工填 TODO（决策理由、使用示例、非目标）
        ↓
verify-module 校验完整性
        ↓
通过则提交

node scripts/doc_generator.js <模块路径>
node scripts/doc_generator.js <模块路径> --force   # 强制覆盖（慎用）
node scripts/doc_generator.js <模块路径> --json    # CI 用

Sponsors

SnugThe clipboard manager you and your agent can use, safelyAgent CaffeineClose your lid, come back to finished workWaxBlock anything with supervision, without erasing your iPhoneOpen StepsSponsoredFree and open-source skills that make AI coding agents easier to understand, verify, and control.