One-click install
npx skills add https://github.com/calcosmic/Aether --skill documentation-generation-calcosmic
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generation
Source: https://github.com/calcosmic/Aether/tree/main/.aether/skills-codex/colony/documentation-generation
Command: npx skills add https://github.com/calcosmic/Aether --skill documentation-generation-calcosmic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Project documentation often drifts from the actual codebase, creating confusion and misleading claims.

Core Features & Use Cases

  • Read actual source code and extract verified facts to generate README, API docs, CHANGELOG, and architecture summaries.
  • Verify all generated content against code behavior, ensuring consistency across releases.
  • Support incremental updates, preserving manual notes and allowing targeted refreshes.

Quick Start

Run a documentation generation pass that reads the codebase and outputs verified project docs.

Frequently Asked Questions about documentation-generation

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

FAQPage Schema
How do I keep my README and API docs accurate as my codebase changes?▼

To keep documentation accurate, you can generate README and API docs by reading actual source code and extracting verified facts. This enforces consistency by verifying all generated content against real code behavior across releases.

How does code-driven documentation generation work?▼

Code-driven documentation generation works by reading actual source code to extract verified facts, which are then used to output READMEs, API docs, and architecture summaries. It verifies all generated content against the actual codebase.

Can I update architecture references incrementally without losing manual notes?▼

Yes, you can perform incremental updates to architecture references while preserving manual notes. The generation process supports targeted refreshes, allowing you to update specific sections without overwriting your manual annotations.

What is the best way to generate a CHANGELOG from source code?▼

The best way to generate a CHANGELOG from source code is to use a generation process that reads the codebase and extracts verified facts. This ensures the CHANGELOG accurately reflects code behavior and remains consistent across releases.

Why does my project documentation drift from the actual codebase over time?▼

Project documentation drifts from the actual codebase when it is maintained manually without verification. Generating docs by codifying code facts solves this by enforcing verification against the actual source code during the generation process.