From d00207026d0b2fd84782aec0fedc5d668081b35d Mon Sep 17 00:00:00 2001 From: Mistifiou Date: Tue, 10 Jun 2025 11:30:40 +0000 Subject: [PATCH] Revise buffer usage --- AGENTS.md | 7 +++---- CONTRIBUTING.md | 10 ++++++++++ README.md | 6 +++--- config.yaml | 2 +- docs/__buffer.md | 2 +- docs/vitepress.md | 10 +++++----- 6 files changed, 23 insertions(+), 14 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/AGENTS.md b/AGENTS.md index 1c04177..c5674ad 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -27,7 +27,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. **Documenter** automatiquement dans `docs/__buffer.md` tout changement significatif. +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. --- @@ -53,9 +53,8 @@ Objectif : permettre à ce repo d'évoluer de prototype à système fonctionnel, - `AGENTS.md` = ton contrat. - `docs/__buffer.md` = mémoire active de l'agent. -- Il contient une section **Mémoire Active** de 30 lignes maximum, sans horodatage. -- Chaque ligne résume une action ou un état. -- Une section *Règles Temporaires* en tête de fichier rappelle les consignes. +- 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. - `docs/knowledge-ethics.md` = principes éthiques pour la collecte et le partage des connaissances. - `src/` = le champ de bataille. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d529346 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +# Contributing Guidelines + +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. +- Run `npm install` once, then `npm test` to validate. +- Submit a pull request describing your updates. + +Please follow the principles in `docs/knowledge-ethics.md` when adding content. diff --git a/README.md b/README.md index b8a6853..8f91edb 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` – short trace of actions, last line = next directive. +- `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. @@ -32,9 +32,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 the last line of `docs/__buffer.md` for the next directive. +2. Check `docs/__buffer.md` for the default note. 3. Propose or apply changes in `src/`, `docs/`, etc. -4. Document actions in `docs/__buffer.md` (maximum 30 lines). +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/config.yaml b/config.yaml index 80ca378..56bef9f 100644 --- a/config.yaml +++ b/config.yaml @@ -1,4 +1,4 @@ mode: prototype language: en -doc_engine: vitedoc +doc_engine: vitepress license: CC BY-SA 4.0 diff --git a/docs/__buffer.md b/docs/__buffer.md index b020924..92cd41f 100644 --- a/docs/__buffer.md +++ b/docs/__buffer.md @@ -1,2 +1,2 @@ Project is blank. -Ask the user to understand project objective and personalize it. \ No newline at end of file +Ask the user to understand project objective and personalize it. diff --git a/docs/vitepress.md b/docs/vitepress.md index dbf0fa9..0c44e22 100644 --- a/docs/vitepress.md +++ b/docs/vitepress.md @@ -1,15 +1,15 @@ -# ViteDoc +# VitePress -This project uses **ViteDoc** to generate static documentation. +This project uses **VitePress** to generate static documentation. ## Commands -- `npm run dev-docs` — start a local server with auto reload. -- `npm run build-docs` — generate the site in `dist/`. +- `npm run docs:dev` — start a local server with auto reload. +- `npm run docs:build` — generate the site in `dist/`. ## Installation ```bash -npm install vitedoc --save-dev +npm install vitepress --save-dev ``` ## Key features