codebase-layout

Organize and document codebase structure with structured metadata output.

29|4|Updated Dec 2, 2025
One-click install
npx skills add https://github.com/bearcove/pikru --skill codebase-layout
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codebase-layout
Source: https://github.com/bearcove/pikru/tree/main/.claude/skills/codebase-layout
Command: npx skills add https://github.com/bearcove/pikru --skill codebase-layout

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Codebase organization and clear documentation help developers understand where functionality lives in a complex project, reducing onboarding time and cognitive load.

Core Features & Use Cases

  • Top-Level Structure overview: src/, crates/, vendor/pikchr-c/, examples/, tests/
  • Module mapping: Parsing (src/parse.rs), Rendering (src/render/...), and tests structure
  • Onboarding & maintenance: guides new contributors to find where core features are implemented

Quick Start

Open the Top-Level Structure section and start at src/ to understand where the core Pikru functionality is implemented

Frequently Asked Questions about codebase-layout

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

FAQPage Schema
How do I document a monorepo codebase structure for new developers?

To document a codebase structure, you map primary directories like src/, crates/, and vendor/ to locate parsing, rendering, and test modules. This skill validates a SKILL.md file and outputs structured metadata including name, tagline, and keywords to improve navigability.

What is the best way to organize a Rust project with layered modules?

The best way to organize layered Rust modules is by mapping core functionality like parsing in src/parse.rs and rendering in src/render/. This skill identifies these components and outputs structured metadata to clarify the codebase layout.

Does this codebase organization approach work for projects with a vendor directory?

Yes, this codebase organization approach works for projects with a vendor directory by identifying top-level paths like vendor/pikchr-c/. It also detects optional directories including scripts/, references/, and assets/ to provide a comprehensive structural overview.

What metadata is generated when documenting a repository's structure?

Documenting a repository's structure generates metadata including name, tagline, description, request, complexity, category, keywords, and components. This metadata is extracted by validating the presence of a SKILL.md file with required frontmatter fields.

How do I locate core functionality in a complex codebase?

To locate core functionality in a complex codebase, start at the src/ directory to find where primary features are implemented. This skill maps module structures like parsing and rendering, guiding developers directly to the relevant code.