Codebase Summary

Overview

This sop analyzes a codebase and generates comprehensive documentation including structured metadata files that describe the system architecture, components, interfaces, and workflows. It can create targeted documentation files like AGENTS.md (README for AI agents), README.md, CONTRIBUTING.md, or generate a complete documentation ecosystem. The documentation is organized to make it easy for AI assistants to understand the system and help with development tasks.

Parameters

• output_dir (optional, default: ".sop/summary"): Directory where documentation will be stored
• consolidate (optional, default: false): Whether to create a consolidated documentation file
• consolidate_target (optional, default: "AGENTS.md"): Target file for consolidation (e.g., "README.md", "CONTRIBUTING.md", or custom filename). Only used if consolidate is true
• consolidate_prompt (optional): Description of how to structure the consolidated content for the target file type (e.g., Reference the AGENTS.md example below for the default "consolidate_prompt"). Only used if consolidate is true
• check_consistency (optional, default: true): Whether to check for inconsistencies across documents
• check_completeness (optional, default: true): Whether to identify areas lacking sufficient detail
• update_mode (optional, default: false): Whether to update existing documentation based on recent changes
• codebase_path (optional, default: current directory): Path to the codebase to analyze