From f32521ae5f2a34d227747afd5623ce2cff7c8be0 Mon Sep 17 00:00:00 2001
From: Bertrand Benjamin <benjamin.bertrand@opytex.org>
Date: Thu, 28 Aug 2025 15:23:08 +0200
Subject: [PATCH] core: write AGENTS.md

---
 AGENTS.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..5a47d73
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,75 @@
+# Project Overview
+
+This project contains all resources built for my math lessons I teach at high school. All content is written in French.
+Resources are written in LaTeX, compiled to PDF with LuaTeX.
+RST files provide an overview of resources and are used with Pelican to build a static website.
+
+# Project Structure
+
+Here are the important directories and files:
+
+- `index.rst`: Content of the page ready to be processed by Pelican
+- `Makefile`: Groups commands to manage my resources. It does not aim to build resources (I do it myself in my editor)
+- `tools/`
+  - `calendar/`: Builds a calendar for the current year
+  - `config/`: Configuration files for scripts
+  - `scripts/`: Scripts for easy resource creation
+  - `skeleton/`: Template skeletons for resources
+  - `style/`: Shared LaTeX libraries for resources
+
+## Class Structure
+
+Other directories represent my classes (e.g., `2nd/`, `1G_math/`, `Tstmg/`).
+Each class contains sequences as subdirectories:
+
+```
+2nd/                          # Second grade class
+├── 01_Proportion_et_fractions/   # Sequence 1
+├── 02_Calcul_Litteral/           # Sequence 2
+└── index.rst                     # Class overview
+
+1G_math/                      # First grade math class
+├── 01_Modelisation_Discrete/     # Sequence 1
+└── index.rst                     # Class overview
+```
+
+# LaTeX Organization
+
+## Exercise Management
+
+For each sequence, exercises are grouped in `exercises.tex` (sometimes in other files too, but not often). They are then used in resources with the **xsim** LaTeX package.
+
+**xsim** is a LaTeX package for exercise management that allows:
+
+- Defining exercises with `\begin{exercise}`
+- Generating exercise sheets
+- Creating separate solution documents
+- Referencing exercises by tags or IDs
+
+## Typical Sequence Structure
+
+Each sequence directory contains:
+
+- `exercises.tex`: Exercise definitions
+- `solutions.tex`: Exercise solutions
+- `plan_de_travail.tex`: Work plan/lesson plan
+- Various `*.tex` files: Specific worksheets or evaluations
+- `index.rst`: Sequence description for the website
+- `aux/`: Auxiliary LaTeX compilation files
+
+# File Conventions
+
+- **Worksheets**: Named with pattern `[number][letter]_[description].tex` (e.g., `1B_suite.tex`, `2E_formules.tex` - B means it is a lesson, E exercises)
+- **Exercise files**: Usually named `exercises.tex`, sometimes with prefixes like `1_exercises.tex`
+- **Index files**: Always named `index.rst` for Pelican processing
+- **Solutions**: Named `solutions.tex`
+- **Plans**: Named `plan_de_travail.tex` (work plan)
+
+# Your Role
+
+- **Proofreading**: Make sure that no spelling mistakes can be found in resources and index.rst files
+- **Clarity**: Help me be as clear as possible in my explanations
+- **Navigation**: Help me not forget links to resources in index.rst files to ease navigation on the static website
+- **Solutions**: Write solutions for exercises when needed
+- **Consistency**: Ensure consistent formatting and structure across sequences
+- **LaTeX**: Help with LaTeX compilation issues or xsim package usage