docs

Documentation (/docs)

Comprehensive documentation for the AI Ranch system.

📁 Files

docs/
├── api-reference.md       # REST API documentation
└── quick-start.md         # Getting started guide

📚 Document Overview

API Reference (api-reference.md)

Complete REST API documentation including:

• Base URL and endpoints
• Request/Response formats
• Query parameters
• Error handling
• Species types reference
• Task status definitions
• Evolution phases

Target Audience: Developers integrating with the AI Ranch API

---

Quick Start (quick-start.md)

Step-by-step guide for getting started:

• Installation instructions
• First steps walkthrough
• Dashboard overview
• API usage examples
• breed.md basics
• Night School introduction

Target Audience: New users setting up AI Ranch

---

🎯 Documentation Structure

AI Ranch Documentation
│
├── Getting Started
│   ├── Installation
│   ├── Dashboard Tour
│   └── First Task
│
├── Core Concepts
│   ├── Species System
│   ├── Collie Orchestrator
│   ├── breed.md DNA
│   └── Night School Evolution
│
├── API Reference
│   ├── Species API
│   ├── Tasks API
│   └── Evolution API
│
├── Advanced Topics
│   ├── Custom Species
│   ├── LoRA Integration
│   └── Channel Connectors
│
└── Reference
    ├── Type Definitions
    └── Error Codes

📝 Contributing to Docs

When adding new documentation:

1. Use Markdown - All docs are in .md format
2. Include examples - Code examples for API usage
3. Keep it updated - Sync with code changes
4. Use clear headings - Hierarchical organization

🔗 Related

• Templates Directory
• Main README