mirror of
https://github.com/soconnor0919/hristudio.git
synced 2025-12-12 23:24:44 -05:00
Sean O'Connor
ab08c1b724
- Add plugin store system with dynamic loading of robot actions - Implement plugin store API routes and database schema - Update experiment designer to support plugin-based actions - Refactor environment configuration and sidebar navigation - Improve authentication session handling with additional user details - Update Tailwind CSS configuration and global styles - Remove deprecated files and consolidate project structure
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# HRIStudio Documentation
|
|
|
|
Welcome to the HRIStudio documentation. This directory contains comprehensive documentation about the design, architecture, and implementation of HRIStudio.
|
|
|
|
## Documentation Structure
|
|
|
|
- [`architecture.md`](./architecture.md) - System architecture, tech stack, and core design decisions
|
|
- [`ui-design.md`](./ui-design.md) - UI/UX guidelines, component structure, and styling decisions
|
|
- [`plugin-store.md`](./plugin-store.md) - Plugin system architecture and implementation details
|
|
- [`auth-and-permissions.md`](./auth-and-permissions.md) - Authentication and role-based access control
|
|
- [`experiment-designer.md`](./experiment-designer.md) - Experiment designer implementation and flow control
|
|
- [`data-layer.md`](./data-layer.md) - Database schema, ORM usage, and data validation
|
|
- [`development.md`](./development.md) - Development guidelines, conventions, and best practices
|
|
- [`future-roadmap.md`](./future-roadmap.md) - Planned features and future enhancements
|
|
|
|
## Quick Start
|
|
|
|
1. Read through [`architecture.md`](./architecture.md) for a high-level overview
|
|
2. Review [`development.md`](./development.md) for development setup and guidelines
|
|
3. Explore specific topics in their dedicated files
|
|
|
|
## Contributing
|
|
|
|
When adding new features or making significant changes:
|
|
|
|
1. Update relevant documentation files
|
|
2. Follow the established format and style
|
|
3. Include code examples where appropriate
|
|
4. Update this README if adding new documentation files |