From f914c3a06bed4330a77e3f3530173f63af56bc30 Mon Sep 17 00:00:00 2001 From: Elias Ahokas Date: Wed, 17 Jun 2026 23:45:00 +0300 Subject: [PATCH] move to a seperate docs directory --- README.md | 10 +++++----- ARCH.md => docs/ARCH.md | 2 +- CONVENTIONS.md => docs/CONVENTIONS.md | 0 JOURNAL.md => docs/JOURNAL.md | 0 SPEC.md => docs/SPEC.md | 0 TESTS.md => docs/TESTS.md | 0 6 files changed, 6 insertions(+), 6 deletions(-) rename ARCH.md => docs/ARCH.md (98%) rename CONVENTIONS.md => docs/CONVENTIONS.md (100%) rename JOURNAL.md => docs/JOURNAL.md (100%) rename SPEC.md => docs/SPEC.md (100%) rename TESTS.md => docs/TESTS.md (100%) diff --git a/README.md b/README.md index ff1417a..697c06b 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,11 @@ Stack and commands. What technologies and what commands does the AI need to know - .aider.conf.yml - Aider config (models, auto-test..) - .gitignore - Common stuff easy to forget. -- SPEC.md - What the project does -- ARCH.md - How it's built -- CONVENTIONS.md - Code style rules -- TESTS.md - Test cases in natural language -- JOURNAL.md - Personal session notes +- docs/SPEC.md - What the project does +- docs/ARCH.md - How it's built +- docs/CONVENTIONS.md - Code style rules +- docs/TESTS.md - Test cases in natural language +- docs/JOURNAL.md - Personal session notes ## Philosophy diff --git a/ARCH.md b/docs/ARCH.md similarity index 98% rename from ARCH.md rename to docs/ARCH.md index d7ecec5..6ab3d4c 100644 --- a/ARCH.md +++ b/docs/ARCH.md @@ -21,6 +21,7 @@ Example: ## File structure +Example: src/ main.py config.py @@ -34,7 +35,6 @@ tests/ One section per non-obvious decision. What we choose, what we rejected, why. Example: - ### Polling vs events - Decision: Polling every 10s - Options: Using interrupts diff --git a/CONVENTIONS.md b/docs/CONVENTIONS.md similarity index 100% rename from CONVENTIONS.md rename to docs/CONVENTIONS.md diff --git a/JOURNAL.md b/docs/JOURNAL.md similarity index 100% rename from JOURNAL.md rename to docs/JOURNAL.md diff --git a/SPEC.md b/docs/SPEC.md similarity index 100% rename from SPEC.md rename to docs/SPEC.md diff --git a/TESTS.md b/docs/TESTS.md similarity index 100% rename from TESTS.md rename to docs/TESTS.md