# Project Documentation Index - Pig Farm Controller

## Project Overview

- **Type:** monolith
- **Primary Language:** Go
- **Architecture:** Layered/API-centric backend service

### Quick Reference

#### main

- **Type:** backend
- **Tech Stack:** Go with Echo and GORM
- **Root:** C:\Users\divano\Desktop\work\AA-Pig\pig-farm-controller\

## Generated Documentation

- [Project Overview](./project-overview.md)
- [Architecture](./architecture-main.md)
- [Source Tree Analysis](./source-tree-analysis.md)
- [Component Inventory](./component-inventory-main.md)
- [Development Guide](./development-guide-main.md)
- [API Contracts](./api-contracts-main.md)
- [Data Models](./data-models-main.md)

## Existing Documentation

- [README.md](./README.md) - Project README
- [Swagger YAML](./docs/swagger.yaml) - API Specification (YAML)
- [Swagger JSON](./docs/swagger.json) - API Specification (JSON)
- [Swagger Go Docs](./docs/docs.go) - Go code for Swagger documentation
- [Open Specifications](./openspec) - Open Specifications Directory
- [Agents Documentation](./AGENTS.md) - Documentation for Agents
- [Relay API Documentation](./RELAY_API.md) - Documentation for Relay API

## Getting Started

Refer to the [Development Guide](./development-guide-main.md) for instructions on setting up and running the project.