bmad-template/.codebuddy/skills/bmad-document-project/templates/index-template.md

# {{project_name}} Documentation Index

**Type:** {{repository_type}}{{#if is_multi_part}} with {{parts_count}} parts{{/if}}
**Primary Language:** {{primary_language}}
**Architecture:** {{architecture_type}}
**Last Updated:** {{date}}

## Project Overview

{{project_description}}

{{#if is_multi_part}}

## Project Structure

This project consists of {{parts_count}} parts:

{{#each project_parts}}

### {{part_name}} ({{part_id}})

- **Type:** {{project_type}}
- **Location:** `{{root_path}}`
- **Tech Stack:** {{tech_stack_summary}}
- **Entry Point:** {{entry_point}}
  {{/each}}

## Cross-Part Integration

{{integration_summary}}

{{/if}}

## Quick Reference

{{#if is_single_part}}

- **Tech Stack:** {{tech_stack_summary}}
- **Entry Point:** {{entry_point}}
- **Architecture Pattern:** {{architecture_pattern}}
- **Database:** {{database}}
- **Deployment:** {{deployment_platform}}
  {{else}}
  {{#each project_parts}}

### {{part_name}} Quick Ref

- **Stack:** {{tech_stack_summary}}
- **Entry:** {{entry_point}}
- **Pattern:** {{architecture_pattern}}
  {{/each}}
  {{/if}}

## Generated Documentation

### Core Documentation

- [Project Overview](./project-overview.md) - Executive summary and high-level architecture
- [Source Tree Analysis](./source-tree-analysis.md) - Annotated directory structure

{{#if is_single_part}}

- [Architecture](./architecture.md) - Detailed technical architecture
- [Component Inventory](./component-inventory.md) - Catalog of major components{{#if has_ui_components}} and UI elements{{/if}}
- [Development Guide](./development-guide.md) - Local setup and development workflow
  {{#if has_api_docs}}- [API Contracts](./api-contracts.md) - API endpoints and schemas{{/if}}
  {{#if has_data_models}}- [Data Models](./data-models.md) - Database schema and models{{/if}}
  {{else}}

### Part-Specific Documentation

{{#each project_parts}}

#### {{part_name}} ({{part_id}})

- [Architecture](./architecture-{{part_id}}.md) - Technical architecture for {{part_name}}
  {{#if has_components}}- [Components](./component-inventory-{{part_id}}.md) - Component catalog{{/if}}
- [Development Guide](./development-guide-{{part_id}}.md) - Setup and dev workflow
  {{#if has_api}}- [API Contracts](./api-contracts-{{part_id}}.md) - API documentation{{/if}}
  {{#if has_data}}- [Data Models](./data-models-{{part_id}}.md) - Data architecture{{/if}}
  {{/each}}

### Integration

- [Integration Architecture](./integration-architecture.md) - How parts communicate
- [Project Parts Metadata](./project-parts.json) - Machine-readable structure
  {{/if}}

### Optional Documentation

{{#if has_deployment_guide}}- [Deployment Guide](./deployment-guide.md) - Deployment process and infrastructure{{/if}}
{{#if has_contribution_guide}}- [Contribution Guide](./contribution-guide.md) - Contributing guidelines and standards{{/if}}

## Existing Documentation

{{#if has_existing_docs}}
{{#each existing_docs}}

- [{{title}}]({{path}}) - {{description}}
  {{/each}}
  {{else}}
  No existing documentation files were found in the project.
  {{/if}}

## Getting Started

{{#if is_single_part}}

### Prerequisites

{{prerequisites}}

### Setup

```bash
{{setup_commands}}
```

### Run Locally

```bash
{{run_commands}}
```

### Run Tests

```bash
{{test_commands}}
```

{{else}}
{{#each project_parts}}

### {{part_name}} Setup

**Prerequisites:** {{prerequisites}}

**Install & Run:**

```bash
cd {{root_path}}
{{setup_command}}
{{run_command}}
```

{{/each}}
{{/if}}

## For AI-Assisted Development

This documentation was generated specifically to enable AI agents to understand and extend this codebase.

### When Planning New Features:

**UI-only features:**
{{#if is_multi_part}}→ Reference: `architecture-{{ui_part_id}}.md`, `component-inventory-{{ui_part_id}}.md`{{else}}→ Reference: `architecture.md`, `component-inventory.md`{{/if}}

**API/Backend features:**
{{#if is_multi_part}}→ Reference: `architecture-{{api_part_id}}.md`, `api-contracts-{{api_part_id}}.md`, `data-models-{{api_part_id}}.md`{{else}}→ Reference: `architecture.md`{{#if has_api_docs}}, `api-contracts.md`{{/if}}{{#if has_data_models}}, `data-models.md`{{/if}}{{/if}}

**Full-stack features:**
→ Reference: All architecture docs{{#if is_multi_part}} + `integration-architecture.md`{{/if}}

**Deployment changes:**
{{#if has_deployment_guide}}→ Reference: `deployment-guide.md`{{else}}→ Review CI/CD configs in project{{/if}}

---

_Documentation generated by BMAD Method `document-project` workflow_