exploring-well-documented-code

What problem does it solve?

This Skill solves the problem of inefficient and time-consuming code exploration by guiding users through a systematic process that focuses on contracts and documentation.

Core Features & Use Cases

• Token-Efficient Exploration: Navigate and understand a codebase by reading contracts (types, signatures, and documentation) rather than implementation details.
• Contract-Driven Understanding: Build a layer-by-layer understanding of a codebase starting with type declarations and moving on to signatures and doc comments.
• Subagent Integration: Utilize Explore subagents for broader exploration, or perform targeted queries using Glob, Grep, and Read commands.
• Documentation as Source: Emphasize that documentation is the primary source of truth when understanding code functionality.

Quick Start

Run the "explore-code" subagent to begin the exploration process of the 'main-project' codebase.