From bb38d64962be3448e39c0c356a7f62442427e54c Mon Sep 17 00:00:00 2001 From: CRF1408 <76657627+CRF1408@users.noreply.github.com> Date: Wed, 7 Jan 2026 19:14:57 +0100 Subject: [PATCH] Create project-structure Added documentation explaining the project structure and contribution layout. --- docs/project-structure | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/project-structure diff --git a/docs/project-structure b/docs/project-structure new file mode 100644 index 00000000..9559ad54 --- /dev/null +++ b/docs/project-structure @@ -0,0 +1,18 @@ +# Project structure + +This doc explains the main folders and where to add new code. + +- `scripts/` — runnable scripts and examples +- `docs/` — documentation and how-to guides +- `tests/` — automated tests (unit/integration) + +## Adding a new script + +1. Create a new file under `scripts/`. +2. Keep it small and focused. +3. Prefer environment variables for configuration. +4. Add a short header comment describing usage. + +## Adding docs + +Put new docs in `docs/` and keep them task-oriented.