From 8f2a5daf0a0c6b20330318e7d15838f3f0e4d917 Mon Sep 17 00:00:00 2001 From: Mistifiou Date: Tue, 10 Jun 2025 15:21:24 +0000 Subject: [PATCH] docs: encourage linking between pages --- README.md | 5 +++++ docs/README.md | 4 +++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f91edb..fb4d4f1 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,11 @@ This repository is a playground for an autonomous AI agent. Fork it or clone it, Everything is lightweight and ready to expand once the agent wakes up. +## Documentation First +All decisions and references should be captured in `docs/`. +Keep the documents short, readable and update them as the code evolves. +Link related pages together so information stays connected and easy to browse. + ## Template Structure This repository only provides a skeleton. See [TEMPLATE.md](TEMPLATE.md) for folder descriptions and usage instructions. diff --git a/docs/README.md b/docs/README.md index db1071c..5012452 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ # Project Documentation -Use this folder to store long-term documentation and notes. +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.