Create AGENTS.md Documentation for Repository Guidelines

[bracesproul]

You're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an AGENTS.md file in the root of the repository.

• General Rules: These are general rules any developer/agent should follow when writing code. It should contain rules such as "When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.
• Repository Structure: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.
• Dependencies and Installation: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management.
• Testing Instructions: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.

Ensure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:
<general_rules>
</general_rules>
<repository_structure>
</repository_structure>
<dependencies_and_installation>
</dependencies_and_installation>
<testing_instructions>
</testing_instructions>

It is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.

The file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed CONTRIBUTING.md file.

With all of this in mind, please explore the repository and write this single AGENTS.md file with the rules/context/instructions gathered!

Agent Context

{ "tasks": [ { "id": "8b2aa469-a1f9-4ed9-9ab5-12bacfbbf06a", "taskIndex": 0, "request": "[original issue]\n**Create AGENTS.md Documentation for Repository Guidelines**\nYou're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an `AGENTS.md` file in the root of the repository.\n\n- **General Rules**: These are general rules any developer/agent should follow when writing code. It should contain rules such as \"When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file\". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.\n- **Repository Structure**: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.\n- **Dependencies and Installation**: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management. \n- **Testing Instructions**: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.\n\nEnsure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:\n\n\n\n\n\n\n\n\n\nIt is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.\n\nThe file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed `CONTRIBUTING.md` file.\n\nWith all of this in mind, please explore the repository and write this single `AGENTS.md` file with the rules/context/instructions gathered!", "title": "Create AGENTS.md documentation file with repository guidelines and structure", "createdAt": 1753155995150, "completed": false, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "Create AGENTS.md file in the root directory with comprehensive repository guidelines including: General Rules section covering code development practices (searching existing functions before creating new ones, using Ruff for backend linting/formatting via 'make format' and 'make lint', using ESLint/Prettier for frontend via 'yarn lint' and 'yarn format'), Repository Structure section describing the dual backend/frontend architecture (backend/ contains Python LangGraph implementation with retrieval_graph/ for core chat logic, ingest.py for document processing, configuration.py for parameters; frontend/ contains Next.js TypeScript app with components/ for UI and API routes), Dependencies and Installation section covering Poetry for backend dependencies and Yarn for frontend dependencies, and Testing Instructions section explaining pytest usage for backend evaluation tests in backend/tests/evals/ with LangSmith integration for model evaluation", "completed": true, "summary": "Successfully created the AGENTS.md file in the root directory with comprehensive repository guidelines. The file includes all four required sections properly wrapped in XML tags:\n\n1. **General Rules**: Covers code development practices including searching existing modules before creating new functions, using Ruff for backend linting/formatting via 'make format' and 'make lint', using ESLint/Prettier for frontend via 'yarn lint' and 'yarn format', following LangGraph patterns, and configuration management practices.\n\n2. **Repository Structure**: Describes the dual backend/frontend architecture with detailed breakdown of the backend/ directory (Python LangGraph implementation with retrieval_graph/ for core chat logic, ingest.py for document processing, configuration.py for parameters) and frontend/ directory (Next.js TypeScript app with components/, API routes, hooks, contexts, and utils).\n\n3. **Dependencies and Installation**: Covers Poetry for backend dependencies (Python 3.11+ required) and Yarn for frontend dependencies, along with environment setup instructions for required API keys.\n\n4. **Testing Instructions**: Explains pytest usage for backend evaluation tests in backend/tests/evals/ with LangSmith integration for model evaluation, including specific test files, required environment variables, and CI/CD integration.\n\nThe file follows the exact XML tag structure requested and provides practical, actionable guidelines for developers new to the repository. All content is based on thorough exploration of the codebase including configuration files (pyproject.toml, package.json, Makefile), source code structure, testing framework, and CI/CD workflows." } ], "createdAt": 1753155995150, "createdBy": "agent" } ], "activeRevisionIndex": 0 } ], "activeTaskIndex": 0 }