From c5c9675bf7cdb07c2c54230c460154581a0f14d3 Mon Sep 17 00:00:00 2001
From: Nhu Viet Nguyen <braveryandglory@gmail.com>
Date: Wed, 31 Aug 2022 11:45:54 +0200
Subject: [PATCH] doc: adding more readmes per each root directory

---
 compositions/README.md | 16 ++++++++++++++++
 testkit/README.md      | 11 +++++++++++
 tests/README.md        |  8 ++++++++
 3 files changed, 35 insertions(+)
 create mode 100644 compositions/README.md
 create mode 100644 testkit/README.md
 create mode 100644 tests/README.md

diff --git a/compositions/README.md b/compositions/README.md
new file mode 100644
index 00000000..763b70a2
--- /dev/null
+++ b/compositions/README.md
@@ -0,0 +1,16 @@
+# Compositions
+
+Please navigate to the `manifest.toml` if you want to know more about which test cases/params are defined for the compositions
+to set during test runs
+
+## local-docker
+
+This directory contains sanity compositions that can be easily run on a local PC or any small VM(e.g. DO droplet)
+The motivation is to do quick regression check-ups if any PR arises from the stack(core/app/node etc.)
+
+## cluster-k8s
+
+This directory contains compositions that are described in `docs/test-plans`. The sorting of inner directories
+are following the same pattern as the test-plan to test-case placement. Namings of directories and files follow this style:
+
+`test-case-id` -> `participants-amount` -> `bandwidth-latency-per-participant`
diff --git a/testkit/README.md b/testkit/README.md
new file mode 100644
index 00000000..43bb4b0d
--- /dev/null
+++ b/testkit/README.md
@@ -0,0 +1,11 @@
+# Testing Kit
+
+This directory contains all necessary implementations that are utilized in `tests` directory
+
+Mainly:
+
+- Sync Topics
+- App Creation and CLI handling
+- Node Creation
+
+Please follow up to dedicated inner `doc.go` for more details
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 00000000..90939ee5
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,8 @@
+# Tests
+
+Each `*.go` follows the naming of the test-case in `docs/test-plan/test-plan-id/*`. 
+
+In order to not clutter the test-file with different participants' steps, each dedicated directory is created to 
+maintain steps of each types of participants. 
+
+The `common` directory is maintaining steps for a participant that plays the same role in every of the test-case(e.g. creating a validators set)
\ No newline at end of file