the-jordan-lab/docs
1
0
Fork 0
mirror of https://github.com/the-jordan-lab/docs.git synced 2025-05-09 21:32:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
docs/ROBOT_README.md
GitHub Action 883953bb0d Auto-update ROBOT_README.md [skip ci]
2025-05-09 11:50:51 +00:00

1.6 KiB
Raw Permalink Blame History

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.
  • 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.

Additional Directories

  • Agent/: Contains the code for the AI agent integration, including the task-runner and hooks.
  • Analysis/: Directory containing repository files.
  • Experiments/: Records of individual experiments or lab sessions.
  • Templates/: Contains starter templates for various YAML structures.
  • aims_files/: Directory containing repository files.
  • building_labagent/: Directory containing repository files.
  • guides/: Directory containing repository files.
  • protocols/: Directory containing repository files.
  • random_scripts/: Directory containing repository files.

This file will be updated whenever the repository structure changes to ensure the robot has the latest context.