From 32dfdf1440d38ffc619c9764da1a820ee4d83b93 Mon Sep 17 00:00:00 2001 From: Mistifiou Date: Tue, 10 Jun 2025 17:10:38 +0000 Subject: [PATCH] Update buffer doc --- AGENTS.md | 7 +++---- CONTRIBUTING.md | 2 +- README.md | 6 +++--- docs/__buffer.md | 2 -- docs/buffer.md | 9 +++++---- tests/docs.test.js | 6 +++--- 6 files changed, 15 insertions(+), 17 deletions(-) delete mode 100644 docs/__buffer.md diff --git a/AGENTS.md b/AGENTS.md index c5674ad..32783de 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,7 +14,6 @@ Objectif : permettre à ce repo d'évoluer de prototype à système fonctionnel, / # Racine ├── AGENTS.md # Ce fichier, ton manuel d'ordre ├── README.md # Rendu automatique si vide -├── docs/__buffer.md # Mémoire active (30 lignes max) ├── docs/ # Mémoire long terme (vision, specs, design) ├── src/ # Code source (modules, outils, exécutables) ├── data/ # Données d'entrée ou d'apprentissage @@ -27,7 +26,7 @@ Objectif : permettre à ce repo d'évoluer de prototype à système fonctionnel, 1. **Initier** la structure du projet si absente (minimale mais propre). 2. **Observer** toute modification et proposer des réorganisations si utile. -3. **Maintenir** `docs/__buffer.md` avec la note par défaut indiquant que le projet est vide. +3. **Maintenir** `docs/buffer.md` avec la note par défaut indiquant que le projet est vide. 4. **Suggérer** des améliorations ou des modules utiles si vide ou bancal. --- @@ -45,14 +44,14 @@ Objectif : permettre à ce repo d'évoluer de prototype à système fonctionnel, ## 🚫 Restrictions strictes - Limite la taille des fichiers à **100 lignes par fichier**. -- Ne touche jamais à un fichier inconnu **sans le documenter** dans `docs/__buffer.md`. +- Ne touche jamais à un fichier inconnu **sans le documenter** dans `docs/buffer.md`. --- ## 🧬 Références internes - `AGENTS.md` = ton contrat. -- `docs/__buffer.md` = mémoire active de l'agent. +- `docs/buffer.md` = mémoire active de l'agent. - Il ne conserve qu'une note concise : "Project is blank. Ask the user to understand project objective and personalize it.". - Ne pas y enregistrer l'historique des actions. - `docs/` = la stratégie long terme. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d529346..d3f343c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ Thanks for your interest in improving this project! - Fork the repository and create a branch for your changes. -- Keep files under 100 lines. `docs/__buffer.md` stores only the default note. +- Keep files under 100 lines. `docs/buffer.md` stores only the default note. - Run `npm install` once, then `npm test` to validate. - Submit a pull request describing your updates. diff --git a/README.md b/README.md index fb4d4f1..d14184d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository is a playground for an autonomous AI agent. Fork it or clone it, ## How it works - `AGENTS.md` – the rules the agent must follow. -- `docs/__buffer.md` – default note about the project being blank. +- `docs/buffer.md` – default note about the project being blank. - `docs/` – long term strategy and notes. - `docs/knowledge-ethics.md` – ethical guidelines for reliable information. - `src/`, `tests/` – code and targets to defeat. @@ -37,9 +37,9 @@ This project is designed to be driven by a **Codex**-type AI (such as ChatGPT or ### Interaction Flow 1. Read `AGENTS.md` to understand the behaviour rules. -2. Check `docs/__buffer.md` for the default note. +2. Check `docs/buffer.md` for the default note. 3. Propose or apply changes in `src/`, `docs/`, etc. -4. No log is kept in `docs/__buffer.md`. +4. No log is kept in `docs/buffer.md`. 5. Use `docs/roadmap.md` to plan future evolution. 6. Run `npm test` if significant changes are made. diff --git a/docs/__buffer.md b/docs/__buffer.md deleted file mode 100644 index 92cd41f..0000000 --- a/docs/__buffer.md +++ /dev/null @@ -1,2 +0,0 @@ -Project is blank. -Ask the user to understand project objective and personalize it. diff --git a/docs/buffer.md b/docs/buffer.md index c0e901e..0ab400f 100644 --- a/docs/buffer.md +++ b/docs/buffer.md @@ -1,6 +1,7 @@ # Utilisation du buffer +- Project is blank. Ask the user to understand project objective and personalize it. -Le fichier `docs/__buffer.md` sert de **mémoire active** pour l'agent. Il ne doit pas devenir un journal de bord. +Le fichier `docs/buffer.md` sert de **mémoire active** pour l'agent. Il ne doit pas devenir un journal de bord. ## Règles principales - Limiter le contenu à 30 lignes (hors commentaires). @@ -17,6 +18,6 @@ Le fichier `docs/__buffer.md` sert de **mémoire active** pour l'agent. Il ne do Conservez uniquement ces notes éphémères qui orientent l'étape à venir. -Régulièrement, nettoyer ce fichier et soit: -- Antériner les règles dans une documentation dédiée -- Supprimer la règle \ No newline at end of file +Régulièrement, nettoyez ce fichier et soit : +- Antérinez les règles dans une documentation dédiée +- Supprimez la règle obsolète. diff --git a/tests/docs.test.js b/tests/docs.test.js index 62cbc0d..6c705c4 100644 --- a/tests/docs.test.js +++ b/tests/docs.test.js @@ -31,9 +31,9 @@ describe('Documentation build', () => { }); }); -describe('__buffer.md', () => { - it('__buffer.md should not exceed 30 non-comment lines', () => { - const content = readFileSync('docs/__buffer.md', 'utf8'); +describe('buffer.md', () => { + it('buffer.md should not exceed 30 non-comment lines', () => { + const content = readFileSync('docs/buffer.md', 'utf8'); const lines = content.split('\n').filter(l => l.trim() !== '' && !l.startsWith('#')); expect(lines.length).toBeLessThanOrEqual(30); });