doc-condenser

What problem does it solve?

It reduces verbose technical documentation into compact, developer-focused specifications that surface file paths, key metrics, and representative code patterns for faster engineering consumption while avoiding unnecessary narrative.

Core Features & Use Cases

• Paths first: preserves and lists full or project-relative file paths so readers can quickly locate source files.
• Tables over prose: converts metrics, coverage, and file listings into scannable tables.
• Code preservation rules: keeps short illustrative snippets and replaces long examples with representative patterns plus source references.
• Use case: convert a long design document or README into a single-page implementation spec that highlights architecture, implementation files, and a quick-reference summary.
• Guidance & constraints: enforces a 40% length cap, explicit rules for KEEP/CONDENSE/REMOVE, and a style guide for consistent formatting; see assets/template.md and references/style-guide.md for templates and patterns.

Quick Start

Condense the repository README into a 40% word-budget specification that preserves every file path and retains representative code snippets while following the style guide.