docs/ROBOT_README.md

30 lines
1.8 KiB
Markdown
Raw Normal View History

2025-05-07 23:52:22 -04:00
# Robot Table of Contents
This file serves as a robot table of contents for the repository. It lists the structure of the repository and points to relevant .md files for context.
## Repository Structure
- **CHANGELOG.md**: Chronological record of all significant changes made to the repository and lab activities. Updated automatically by the agent after each major action.
2025-05-07 23:52:22 -04:00
- **ENVIRONMENT_SETUP.md**: Guide for setting up the development environment, including GitHub CLI and OpenAI API key configuration.
- **ISSUES_LOG.md**: Logs all GitHub issues created, automatically updated by the Lab Agent.
- **README.md**: Main repository README with quick-start instructions and overview.
- **TASKS.md**: Tracks ongoing lab and development tasks, automatically updated by the Lab Agent.
- **aims.md**: Defines high-level research aims and objectives that organize the lab's projects and experiments.
2025-05-07 23:52:22 -04:00
## Additional Directories
- **agent/**: Contains the code for the AI agent integration, including the task-runner and hooks.
2025-05-08 13:57:45 -04:00
- **aims_files/**: Directory containing repository files.
- **analysis/**: Directory containing repository files and analysis code.
2025-05-07 23:52:22 -04:00
- **building_labagent/**: Directory containing repository files.
- **cursor_env/**: Directory containing Python environment files.
- **data/**: Directory containing experimental data files organized by experiment ID.
- **experiments/**: Records of individual experiments or lab sessions.
2025-05-07 23:52:22 -04:00
- **guides/**: Directory containing repository files.
- **protocols/**: Directory containing repository files.
- **random_scripts/**: Directory containing repository files.
- **templates/**: Contains starter templates for various YAML structures.
2025-05-07 23:52:22 -04:00
---
_This file will be updated whenever the repository structure changes to ensure the robot has the latest context._