first

ai-agent/AGENTS.md

@@ -0,0 +1,38 @@
+# Workspace Agent Instructions
+
+## Folder Structure & Purpose
+
+- `ai-agent`: Agent workspace for internal notes, chat logs, and todo lists.
+- `code`: Ground truth for all program code. Only source files belong here.
+- `documentation`: User-facing documentation in Markdown format.
+- `tests`: Unit tests only.
+
+**Strict separation:**
+- Agent materials → `ai-agent`
+- Source code → `code`
+- Documentation → `documentation`
+- Tests → `tests`
+
+## Agent Workflow Principles
+
+- Always respect folder boundaries and intended purposes.
+- Never mix code, docs, tests, or agent materials across folders.
+- When generating new files, place them in the correct folder by type.
+- When updating instructions, preserve valuable content and remove outdated or duplicate sections.
+
+## Anti-Patterns
+
+- Do not store code, documentation, or tests in `ai-agent`.
+- Do not place agent notes, logs, or todos in `code`, `documentation`, or `tests`.
+- Do not duplicate content across folders.
+
+## Example Prompts
+
+- "Create a new script in `code` for data processing."
+- "Add a Markdown guide to `documentation` explaining the backup process."
+- "Write unit tests for the backup logic in `tests`."
+- "Store my agent notes in `ai-agent`."
+
+---
+
+For advanced customization, use applyTo-based instructions for specific areas (e.g., frontend, backend, tests) as the project grows.

ai-agent/INSTRUCTIONS-FOLDERS.md

@@ -0,0 +1,41 @@
+# Project folder rules for the AI agent
+
+This file defines what the subfolders are for and how I should use them.
+
+## 1) `ai-agent`
+Purpose: Working directory of the AI agent.
+
+How I use it:
+- I store all the files I need for my work here.
+- I save internal information and notes here.
+- I store previous chat histories here.
+- I create and maintain my to-do lists here.
+
+## 2) `code`
+Purpose: Ground truth of the programme code.
+
+My use:
+- This directory contains only programme code.
+- All source code files are stored here.
+- I treat the content as the authoritative code base.
+
+## 3) `documentation` (technical term: ‘documentation’)
+Purpose: User documentation.
+
+How I use it:
+- I create Markdown documents here to explain the programme functions.
+- I keep the documentation understandable and user-oriented.
+
+## 4) `tests`
+Purpose: Test directory.
+
+How I use it:
+- This is where the unit tests are stored.
+- I create new unit tests in this directory.
+
+## General rule
+I strictly separate content according to purpose:
+- Agent work material only in `ai-agent`
+- Source code only in `code`
+- User documentation only in `documentation`
+- Unit tests only in `tests`

ai-agent/INSTRUCTIONS.md

@@ -0,0 +1,28 @@
+A script is to be created that runs on a TrueNAS server.
+The server contains several datasets and storage hard drives.
+The script is to back up an entire directory from another external server.
+To do this:
+1) The entire directory is to be copied locally (to the storage hard drives) using rsync.
+2) Then, all changes should be versioned with a git commit (local git command).
+
+This workflow is given and will not be changed. 
+No backup tool or Git server will be used. Simply rsync to the disk + git commit. It's that simple.
+
+# Configuration
+No configuration must be in the script. 
+A env file must be used for config.
+
+# Git commit
+
+Only create a new git commit, if something has changed.
+
+# Rsync
+
+No visual feedback or verbos mode needed.
+
+recommended options:
+
+-a  archive mode
+-v  verbose
+-z  compression
+--delete remove deleted files