From 21cd09569b7a197e78d35c23cd1d472b65cc23c5 Mon Sep 17 00:00:00 2001 From: Mistifiou Date: Tue, 10 Jun 2025 09:06:38 +0000 Subject: [PATCH] Revert buffer modifications --- README.md | 79 +++++++++++++++++---------------------- TEMPLATE.md | 24 ++++++------ docs/.vitepress/config.js | 1 + docs/index.md | 5 +-- docs/roadmap.md | 20 +++++----- docs/vitepress.md | 15 ++++---- package.json | 2 +- 7 files changed, 67 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index dd1baef..b8a6853 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,45 @@ -# Template Codex Brutal +# Codex Brutal Template [![pages-build-deployment](https://github.com/socle-commun/example-codex-project/actions/workflows/deploy.yml/badge.svg)](https://github.com/socle-commun/example-codex-project/actions/workflows/deploy.yml) -Ce dépôt sert de champ d'entraînement pour un agent IA autonome. -Forke-le sur GitHub (ou clones-le), lance l'agent, puis laisse-le evoluer. -Ce dépôt est volontairement vide : il ne contient que la structure minimale. +This repository is a playground for an autonomous AI agent. Fork it or clone it, start the agent and let it evolve. The project intentionally contains only the minimal skeleton. -## Mode opératoire -- `AGENTS.md` : la loi que l'agent suit à la lettre. -- `docs/__buffer.md` : trace condensée des actions, dernière ligne = prochaine directive. -- `docs/` : stratégie et mémoire longue. -- `docs/knowledge-ethics.md` : principes éthiques pour garantir la fiabilité des informations. -- `src/`, `tests/` : code et cibles à abattre. +## How it works +- `AGENTS.md` – the rules the agent must follow. +- `docs/__buffer.md` – short trace of actions, last line = next directive. +- `docs/` – long term strategy and notes. +- `docs/knowledge-ethics.md` – ethical guidelines for reliable information. +- `src/`, `tests/` – code and targets to defeat. -Tout est minimaliste mais prêt à être étendu par l'agent dès son réveil. +Everything is lightweight and ready to expand once the agent wakes up. -## Structure du Template - -Le dépôt sert uniquement de squelette. Consultez [TEMPLATE.md](TEMPLATE.md) pour -la description des dossiers et la marche à suivre. +## Template Structure +This repository only provides a skeleton. See [TEMPLATE.md](TEMPLATE.md) for folder descriptions and usage instructions. ## Installation - - `npm install` -- `npm run docs:dev` pour lancer un serveur local de documentation -- `npm run docs:build` pour produire `dist/` +- `npm run docs:dev` to launch the documentation server +- `npm run docs:build` to generate `dist/` -Une fois les dépendances installées, exécutez `npm test` pour lancer les tests. -Aucun script de démonstration n'est fourni : rien ne s'exécute tant que l'agent -n'entre pas en action. +Once dependencies are installed, run `npm test` to execute the tests. No demo scripts are shipped: nothing runs until the agent acts. ## Configuration -Le fichier `config.yaml` centralise quelques réglages : -- `mode` indique que le projet est en phase de prototype. -- `doc_engine` spécifie l'outil **VitePress** utilisé pour générer la documentation. - -## Utilisation avec ChatGPT ou Codex - -Ce projet est conçu pour être manipulé directement par une IA de type **Codex** (comme ChatGPT, ou un agent externe autonome). - -### Mode d'interaction : - -1. Lire `AGENTS.md` pour comprendre les règles de comportement. -2. Lire la dernière ligne de `docs/__buffer.md` pour exécuter une directive. -3. Proposer ou effectuer les changements nécessaires dans `src/`, `docs/`, etc. -4. Documenter les actions dans `docs/__buffer.md` (30 lignes max). -5. Utiliser `docs/roadmap.md` pour planifier l'évolution. -6. Lancer `npm test` si des changements importants sont faits. - -## Licence - -Ce projet est distribué sous licence Creative Commons BY-SA 4.0. Voir le fichier [LICENSE](LICENSE) pour le texte complet. - -## Consultation Web - -➡️ Accéder à la documentation : [example-codex-project on GitHub Pages](https://socle-commun.github.io/example-codex-project/) +Settings are centralized in `config.yaml`: +- `mode` indicates the prototype stage. +- `doc_engine` specifies the **VitePress** documentation generator. + +## Working with ChatGPT or Codex +This project is designed to be driven by a **Codex**-type AI (such as ChatGPT or another autonomous agent). + +### Interaction Flow +1. Read `AGENTS.md` to understand the behaviour rules. +2. Check the last line of `docs/__buffer.md` for the next directive. +3. Propose or apply changes in `src/`, `docs/`, etc. +4. Document actions in `docs/__buffer.md` (maximum 30 lines). +5. Use `docs/roadmap.md` to plan future evolution. +6. Run `npm test` if significant changes are made. + +## License +This project is distributed under the Creative Commons BY-SA 4.0 license. See [LICENSE](LICENSE) for details. + +## Web View +➡️ Access the documentation: [example-codex-project on GitHub Pages](https://socle-commun.github.io/example-codex-project/) diff --git a/TEMPLATE.md b/TEMPLATE.md index 8aefd17..f461706 100644 --- a/TEMPLATE.md +++ b/TEMPLATE.md @@ -1,18 +1,18 @@ -# Template IA Minimaliste +# Minimalist AI Template -Ce dépôt fournit un squelette volontairement vide pour démarrer un projet d'agent IA autonome. Il ne contient aucun code applicatif mais propose une organisation de base. +This repository provides an intentionally empty skeleton to start an autonomous AI agent project. It contains no application code but offers a basic organization. -## Dossiers principaux +## Main folders -- `src/` – accueillera le code source. -- `tests/` – contiendra les suites de tests. -- `data/` – stockage éventuel des données d'entraînement ou de jeu d'essai. -- `docs/` – documentation longue et generation statique. +- `src/` – where the source code will live. +- `tests/` – where test suites reside. +- `data/` – optional storage for training or sample data sets. +- `docs/` – long-form documentation and static site generation. -## Démarrer +## Getting started -1. Forkez ce dépôt sur GitHub ou clonez-le localement. -2. Ajoutez votre code dans `src/` et vos tests dans `tests/`. -3. Installez les dépendances avec `npm install` puis faites vivre l'agent. +1. Fork this repository on GitHub or clone it locally. +2. Add your code in `src/` and your tests in `tests/`. +3. Install dependencies with `npm install` and let the agent run. -Ce template est prêt à évoluer dès que l'agent entre en action. +This template is ready to evolve as soon as the agent starts acting. diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index bc7ec12..0ef960e 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -1,5 +1,6 @@ export default { // site-level options + lang: 'en-US', title: 'VitePress', description: 'Just playing around.', diff --git a/docs/index.md b/docs/index.md index a746341..036c48a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,9 @@ # Welcome -Bienvenue sur la documentation du template Codex Brutal. Ce guide rassemble la vision -du projet et les règles que l'agent doit suivre. +This documentation provides the vision for the Codex Brutal template and the rules the agent must follow. - [Knowledge Ethics](./knowledge-ethics.md) - [VitePress](./vitepress.md) - [Roadmap](./roadmap.md) -Le site GitHub Pages du projet affiche cette page d'accueil. +The GitHub Pages site displays this page as the home page. diff --git a/docs/roadmap.md b/docs/roadmap.md index 2e9b21a..5521591 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,15 +1,15 @@ # Roadmap -Ce document trace les grandes etapes prevues pour faire evoluer le template. +This document tracks the main steps planned to evolve the template. -## Objectifs a court terme -- Finaliser la documentation de base et verifier les tests existants. -- Mettre en place les premieres fonctionnalites de demonstration. +## Short-term goals +- Finalize basic documentation and verify existing tests. +- Introduce initial demonstration features. -## Objectifs a moyen terme -- Ajouter des modules pour automatiser la generation de contenu. -- Integrer des jeux de donnees simples afin de tester des outils d'analyse. +## Mid-term goals +- Add modules to automate content generation. +- Integrate simple datasets to test analysis tools. -## Objectifs a long terme -- Transformer ce prototype en plateforme complete utilisable par divers agents IA. -- Etendre la couverture de tests et la documentation pour faciliter les contributions externes. +## Long-term goals +- Turn this prototype into a full platform usable by various AI agents. +- Extend test coverage and documentation to ease external contributions. diff --git a/docs/vitepress.md b/docs/vitepress.md index c93bb4b..dbf0fa9 100644 --- a/docs/vitepress.md +++ b/docs/vitepress.md @@ -1,11 +1,10 @@ - # ViteDoc -Ce projet utilise **ViteDoc** pour generer la documentation statique. +This project uses **ViteDoc** to generate static documentation. -## Commandes -- `npm run dev-docs` — lance un serveur local avec rechargement automatique. -- `npm run build-docs` — genere le site dans `dist/`. +## Commands +- `npm run dev-docs` — start a local server with auto reload. +- `npm run build-docs` — generate the site in `dist/`. ## Installation @@ -13,8 +12,8 @@ Ce projet utilise **ViteDoc** pour generer la documentation statique. npm install vitedoc --save-dev ``` -## Fonctionnalites principales +## Key features -- Support Markdown et apercu interactif de composants +- Markdown support and live component preview - HMR via Vite -- Generation de site statique personnalise +- Customizable static site generation diff --git a/package.json b/package.json index 8bbceb3..a1f2d75 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "example-codex-project", "version": "1.0.0", - "description": "Ce dépôt sert de champ d'entraînement pour un agent IA autonome. Clones-le, lance l'agent, puis laisse-le évoluer.", + "description": "This repository is a playground for an autonomous AI agent. Clone it, start the agent and let it evolve.", "type": "module", "scripts": { "docs:dev": "vitepress dev docs",