From 76bd88ac876d687808b16ddec91c5fba162b252c Mon Sep 17 00:00:00 2001 From: Mistifiou Date: Tue, 10 Jun 2025 19:00:28 +0000 Subject: [PATCH] docs: refine chapters for clarity --- docs/README.md | 4 ++++ docs/index.md | 4 +++- docs/knowledge-ethics.md | 1 + docs/roadmap.md | 2 ++ docs/vitepress.md | 2 ++ 5 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 5012452..d493cf9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,3 +3,7 @@ This folder stores the project's long-term memory. Keep pages concise and update them whenever the code changes. Link documents to each other so topics remain easy to explore. + +See [index](index.md) for the main chapters and consult `docs/buffer.md` for any +temporary notes. The [knowledge ethics](knowledge-ethics.md) page lists guiding +principles for trustworthy content. diff --git a/docs/index.md b/docs/index.md index 036c48a..1ea7dbd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,11 @@ # Welcome -This documentation provides the vision for the Codex Brutal template and the rules the agent must follow. +This documentation outlines 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) +For an overview of all files see [README](README.md). Feedback and improvements are encouraged so every chapter stays current. + The GitHub Pages site displays this page as the home page. diff --git a/docs/knowledge-ethics.md b/docs/knowledge-ethics.md index 8093bc3..e43671d 100644 --- a/docs/knowledge-ethics.md +++ b/docs/knowledge-ethics.md @@ -16,3 +16,4 @@ This document adapts the French **"Manifeste pour l'éthique de la connaissance" 10. **Commitment to improvement** – Practices evolve continually to uphold these ethical standards. By following these guidelines, the project promotes an environment where code, data and ideas can be trusted and built upon by the community. +Return to this list whenever documentation is revised so improvements remain aligned with these principles. diff --git a/docs/roadmap.md b/docs/roadmap.md index 5521591..1012480 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -13,3 +13,5 @@ This document tracks the main steps planned to evolve the template. ## Long-term goals - Turn this prototype into a full platform usable by various AI agents. - Extend test coverage and documentation to ease external contributions. + +This roadmap evolves with feedback from contributors and testing results. Review it often to track progress. diff --git a/docs/vitepress.md b/docs/vitepress.md index 0c44e22..7d63774 100644 --- a/docs/vitepress.md +++ b/docs/vitepress.md @@ -17,3 +17,5 @@ npm install vitepress --save-dev - Markdown support and live component preview - HMR via Vite - Customizable static site generation + +Refer to the [VitePress docs](https://vitepress.vuejs.org/) for advanced setup options.