hristudio/DOCUMENTATION.md

HRIStudio Documentation Overview

Clean, organized documentation for the HRIStudio platform.

Quick Links

Getting Started

• README.md - Main project overview and setup
• Quick Reference - 5-minute setup guide

HRIStudio Platform

• Project Overview - Features and architecture
• Database Schema - Complete database reference
• API Routes - tRPC API documentation
• Implementation Guide - Technical implementation

NAO6 Robot Integration

• NAO6 Quick Reference - Essential commands
• Integration Repository - Complete integration package
  • Installation guide
  • Usage instructions
  • Troubleshooting
  • Plugin definitions

Experiment Design

• Core Blocks System - Experiment building blocks
• Plugin System - Robot plugins

Deployment

• Deployment & Operations - Production deployment

Research

• Research Paper - Academic documentation

Repository Structure

hristudio/                          # Main web application
├── README.md                       # Start here
├── DOCUMENTATION.md                # This file
├── src/                            # Next.js application
├── docs/                           # Platform documentation
└── ...

nao6-hristudio-integration/         # NAO6 integration
├── README.md                       # Integration overview
├── docs/                           # NAO6 documentation
├── launch/                         # ROS2 launch files
├── scripts/                        # Utility scripts
├── plugins/                        # Plugin definitions
└── examples/                       # Usage examples

Documentation Philosophy

• One source of truth - No duplicate docs
• Clear hierarchy - Easy to find what you need
• Practical focus - Real commands, not theory
• Examples - Working code samples

For Researchers

Start here:

1. README.md - Setup HRIStudio
2. NAO6 Quick Reference - Connect NAO robot
3. Project Overview - Understand the system

For Developers

Start here:

1. Implementation Guide - Technical architecture
2. Database Schema - Data model
3. API Routes - Backend APIs

Support

• Check documentation first
• Use NAO6 integration repo for robot-specific issues
• Main HRIStudio repo for platform issues

---

Last Updated: December 2024
Version: 1.0 (Simplified)