mirror of
https://github.com/soconnor0919/hristudio.git
synced 2026-03-23 19:27:51 -04:00
Sean O'Connor
cf3597881b
- Move 30+ outdated docs to docs/_archive/ - Move obsolete root files to _archive/ - Update README.md (Better Auth, current features) - Update docs/README.md (new architecture diagram) - Update docs/quick-reference.md (consolidated) - Update docs/project-status.md (March 2026 state) - Update docs/nao6-quick-reference.md (14 actions, Docker services) - Update docs/implementation-guide.md (Better Auth, git submodule) - Update docs/proposal.tex (timeline updates) - Archive errors.txt, plugin_dump.json, test HTML files
2.8 KiB
2.8 KiB
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:
- README.md - Setup HRIStudio
- NAO6 Quick Reference - Connect NAO robot
- Project Overview - Understand the system
For Developers
Start here:
- Implementation Guide - Technical architecture
- Database Schema - Data model
- 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)