Skip to content

project-birds-eye-view

Generates comprehensive project overview documents with architecture diagrams for new developer onboarding.

Synopsis

/project-birds-eye-view

/rp1-base/project-birds-eye-view

Description

The project-birds-eye-view command creates a comprehensive overview document of your project, suitable for onboarding new team members or providing executive summaries. It leverages the knowledge base and explores the codebase to produce documentation with validated Mermaid diagrams.

The command produces documentation covering:

  • Summary: High-level project description and purpose
  • System Context: External integrations and boundaries
  • Architecture: Layers, patterns, and key decisions
  • Modules: Component breakdown and responsibilities
  • Data Model: Key entities and relationships
  • Workflows: Critical business processes
  • APIs: External and internal interfaces

Parameters

Parameter Default Description
RP1_ROOT .rp1/ Root directory for output

Output

The command generates a comprehensive markdown document:

Location: .rp1/work/project-overview.md

Contents:

  • Project summary with key metrics
  • System context diagram (Mermaid)
  • Architecture diagram (Mermaid)
  • Module breakdown with dependencies
  • Data model diagram (if applicable)
  • Key workflow diagrams
  • API overview

Examples

Generate Overview

/project-birds-eye-view

/rp1-base/project-birds-eye-view

Expected output: 

✅ Project Overview Generated

Summary:
- Project: rp1 Plugin System
- Type: Monorepo with 2 plugins
- Tech Stack: Markdown, Python

Output: .rp1/work/project-overview.md

Sections Generated:
- Summary ✓
- System Context ✓
- Architecture (with diagram) ✓
- Modules ✓
- Data Model (TBD - no schema detected)
- Workflows ✓
- APIs (TBD - no external APIs detected)

Diagram Validation

All Mermaid diagrams are validated before being included. If a diagram fails validation, the command:

  1. Logs a warning
  2. Uses a simplified fallback diagram
  3. Marks the section for manual review

Requirements

Prerequisite

The knowledge base must exist before running this command. Run knowledge-build first.

See Also