From bdd5b7d8ce993edbb3c4813c1be1ba547434f9ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marko=20Mili=C4=87?= Date: Tue, 14 Jul 2026 15:57:46 +0200 Subject: [PATCH 1/3] docs: move root-level docs into docs/ (testing docs under docs/testing/) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit cheat_sheet.md, credits.md, roadmap.md and completed_developments.md move to docs/ (the latter two together — they link to each other relatively). EXTRA_TESTS_TODO.md, todo_shared_ensure_json_content_type.md and TEST_ISOLATION_ADVISE.md move to docs/testing/; the two path strings in .github/scripts/check_test_isolation.py are updated to match. README.md, CONTRIBUTING.md, CLAUDE.md, FAQ.md and release_notes.md stay at the root as conventional top-level files. --- .github/scripts/check_test_isolation.py | 4 ++-- cheat_sheet.md => docs/cheat_sheet.md | 0 completed_developments.md => docs/completed_developments.md | 0 credits.md => docs/credits.md | 0 roadmap.md => docs/roadmap.md | 0 EXTRA_TESTS_TODO.md => docs/testing/EXTRA_TESTS_TODO.md | 0 .../testing/TEST_ISOLATION_ADVISE.md | 0 .../testing/todo_shared_ensure_json_content_type.md | 0 8 files changed, 2 insertions(+), 2 deletions(-) rename cheat_sheet.md => docs/cheat_sheet.md (100%) rename completed_developments.md => docs/completed_developments.md (100%) rename credits.md => docs/credits.md (100%) rename roadmap.md => docs/roadmap.md (100%) rename EXTRA_TESTS_TODO.md => docs/testing/EXTRA_TESTS_TODO.md (100%) rename TEST_ISOLATION_ADVISE.md => docs/testing/TEST_ISOLATION_ADVISE.md (100%) rename todo_shared_ensure_json_content_type.md => docs/testing/todo_shared_ensure_json_content_type.md (100%) diff --git a/.github/scripts/check_test_isolation.py b/.github/scripts/check_test_isolation.py index 5f320dcbf9..2dc552c293 100644 --- a/.github/scripts/check_test_isolation.py +++ b/.github/scripts/check_test_isolation.py @@ -12,7 +12,7 @@ `beforeAll()`, `afterEach()`, or `afterAll()` — blocks that run at test-execution time, not class-instantiation time. -See TEST_ISOLATION_ADVISE.md at the repo root. +See docs/testing/TEST_ISOLATION_ADVISE.md. Run from the repo root: python3 .github/scripts/check_test_isolation.py @@ -219,7 +219,7 @@ def main() -> int: f"\n{total} test-isolation violation(s) found.\n" "Wrap setPropsValues inside scenario {{ ... }} or " "beforeEach()/beforeAll()/afterEach()/afterAll().\n" - "See TEST_ISOLATION_ADVISE.md.", + "See docs/testing/TEST_ISOLATION_ADVISE.md.", file=sys.stderr, ) return 1 diff --git a/cheat_sheet.md b/docs/cheat_sheet.md similarity index 100% rename from cheat_sheet.md rename to docs/cheat_sheet.md diff --git a/completed_developments.md b/docs/completed_developments.md similarity index 100% rename from completed_developments.md rename to docs/completed_developments.md diff --git a/credits.md b/docs/credits.md similarity index 100% rename from credits.md rename to docs/credits.md diff --git a/roadmap.md b/docs/roadmap.md similarity index 100% rename from roadmap.md rename to docs/roadmap.md diff --git a/EXTRA_TESTS_TODO.md b/docs/testing/EXTRA_TESTS_TODO.md similarity index 100% rename from EXTRA_TESTS_TODO.md rename to docs/testing/EXTRA_TESTS_TODO.md diff --git a/TEST_ISOLATION_ADVISE.md b/docs/testing/TEST_ISOLATION_ADVISE.md similarity index 100% rename from TEST_ISOLATION_ADVISE.md rename to docs/testing/TEST_ISOLATION_ADVISE.md diff --git a/todo_shared_ensure_json_content_type.md b/docs/testing/todo_shared_ensure_json_content_type.md similarity index 100% rename from todo_shared_ensure_json_content_type.md rename to docs/testing/todo_shared_ensure_json_content_type.md From 00181c980960695fd162faf0ce6ec460d82c784f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marko=20Mili=C4=87?= Date: Tue, 14 Jul 2026 16:08:10 +0200 Subject: [PATCH 2/3] docs: move temp_docs/ under docs/ Agent-generated summaries and the OIDC/Redis rate-limiting notes move from the repo root to docs/temp_docs/ as-is; sorting them into topical subfolders (IdP, rate-limiting) can follow later. --- {temp_docs => docs/temp_docs}/CHANGES_SUMMARY.md | 0 {temp_docs => docs/temp_docs}/FINAL_SUMMARY.md | 0 {temp_docs => docs/temp_docs}/IMPLEMENTATION_SUMMARY.md | 0 {temp_docs => docs/temp_docs}/OBP_OIDC_Configuration_Guide.md | 0 {temp_docs => docs/temp_docs}/RATE_LIMITING_BUG_FIX.md | 0 .../temp_docs}/REDIS_RATE_LIMITING_DOCUMENTATION.md | 0 {temp_docs => docs/temp_docs}/REDIS_READ_ACCESS_FUNCTIONS.md | 0 {temp_docs => docs/temp_docs}/_NEXT_STEPS.md | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename {temp_docs => docs/temp_docs}/CHANGES_SUMMARY.md (100%) rename {temp_docs => docs/temp_docs}/FINAL_SUMMARY.md (100%) rename {temp_docs => docs/temp_docs}/IMPLEMENTATION_SUMMARY.md (100%) rename {temp_docs => docs/temp_docs}/OBP_OIDC_Configuration_Guide.md (100%) rename {temp_docs => docs/temp_docs}/RATE_LIMITING_BUG_FIX.md (100%) rename {temp_docs => docs/temp_docs}/REDIS_RATE_LIMITING_DOCUMENTATION.md (100%) rename {temp_docs => docs/temp_docs}/REDIS_READ_ACCESS_FUNCTIONS.md (100%) rename {temp_docs => docs/temp_docs}/_NEXT_STEPS.md (100%) diff --git a/temp_docs/CHANGES_SUMMARY.md b/docs/temp_docs/CHANGES_SUMMARY.md similarity index 100% rename from temp_docs/CHANGES_SUMMARY.md rename to docs/temp_docs/CHANGES_SUMMARY.md diff --git a/temp_docs/FINAL_SUMMARY.md b/docs/temp_docs/FINAL_SUMMARY.md similarity index 100% rename from temp_docs/FINAL_SUMMARY.md rename to docs/temp_docs/FINAL_SUMMARY.md diff --git a/temp_docs/IMPLEMENTATION_SUMMARY.md b/docs/temp_docs/IMPLEMENTATION_SUMMARY.md similarity index 100% rename from temp_docs/IMPLEMENTATION_SUMMARY.md rename to docs/temp_docs/IMPLEMENTATION_SUMMARY.md diff --git a/temp_docs/OBP_OIDC_Configuration_Guide.md b/docs/temp_docs/OBP_OIDC_Configuration_Guide.md similarity index 100% rename from temp_docs/OBP_OIDC_Configuration_Guide.md rename to docs/temp_docs/OBP_OIDC_Configuration_Guide.md diff --git a/temp_docs/RATE_LIMITING_BUG_FIX.md b/docs/temp_docs/RATE_LIMITING_BUG_FIX.md similarity index 100% rename from temp_docs/RATE_LIMITING_BUG_FIX.md rename to docs/temp_docs/RATE_LIMITING_BUG_FIX.md diff --git a/temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md b/docs/temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md similarity index 100% rename from temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md rename to docs/temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md diff --git a/temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md b/docs/temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md similarity index 100% rename from temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md rename to docs/temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md diff --git a/temp_docs/_NEXT_STEPS.md b/docs/temp_docs/_NEXT_STEPS.md similarity index 100% rename from temp_docs/_NEXT_STEPS.md rename to docs/temp_docs/_NEXT_STEPS.md From 0ba9f2e63cbc9c60824ca71f336f66699555b905 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marko=20Mili=C4=87?= Date: Tue, 14 Jul 2026 16:16:30 +0200 Subject: [PATCH 3/3] docs: sort temp_docs into topical subfolders (rate-limiting, caching, IdP) Inside docs/temp_docs/: the Redis rate-limiting reference, bug-fix report, read-access-functions note and work notes move to rate-limiting/; the cache-namespace endpoint summaries to caching/; the OBP-OIDC configuration guide to IdP/. The generically named CHANGES_SUMMARY.md, _NEXT_STEPS.md, FINAL_SUMMARY.md and IMPLEMENTATION_SUMMARY.md are renamed to self-describing names and the internal link between the two cache summaries is updated. --- docs/temp_docs/{ => IdP}/OBP_OIDC_Configuration_Guide.md | 0 .../CACHE_NAMESPACE_ENDPOINT_FINAL_SUMMARY.md} | 2 +- .../CACHE_NAMESPACE_IMPLEMENTATION_SUMMARY.md} | 0 docs/temp_docs/{ => rate-limiting}/RATE_LIMITING_BUG_FIX.md | 0 .../RATE_LIMITING_CHANGES_SUMMARY.md} | 0 .../RATE_LIMITING_NEXT_STEPS.md} | 0 .../{ => rate-limiting}/REDIS_RATE_LIMITING_DOCUMENTATION.md | 0 .../{ => rate-limiting}/REDIS_READ_ACCESS_FUNCTIONS.md | 0 8 files changed, 1 insertion(+), 1 deletion(-) rename docs/temp_docs/{ => IdP}/OBP_OIDC_Configuration_Guide.md (100%) rename docs/temp_docs/{FINAL_SUMMARY.md => caching/CACHE_NAMESPACE_ENDPOINT_FINAL_SUMMARY.md} (97%) rename docs/temp_docs/{IMPLEMENTATION_SUMMARY.md => caching/CACHE_NAMESPACE_IMPLEMENTATION_SUMMARY.md} (100%) rename docs/temp_docs/{ => rate-limiting}/RATE_LIMITING_BUG_FIX.md (100%) rename docs/temp_docs/{CHANGES_SUMMARY.md => rate-limiting/RATE_LIMITING_CHANGES_SUMMARY.md} (100%) rename docs/temp_docs/{_NEXT_STEPS.md => rate-limiting/RATE_LIMITING_NEXT_STEPS.md} (100%) rename docs/temp_docs/{ => rate-limiting}/REDIS_RATE_LIMITING_DOCUMENTATION.md (100%) rename docs/temp_docs/{ => rate-limiting}/REDIS_READ_ACCESS_FUNCTIONS.md (100%) diff --git a/docs/temp_docs/OBP_OIDC_Configuration_Guide.md b/docs/temp_docs/IdP/OBP_OIDC_Configuration_Guide.md similarity index 100% rename from docs/temp_docs/OBP_OIDC_Configuration_Guide.md rename to docs/temp_docs/IdP/OBP_OIDC_Configuration_Guide.md diff --git a/docs/temp_docs/FINAL_SUMMARY.md b/docs/temp_docs/caching/CACHE_NAMESPACE_ENDPOINT_FINAL_SUMMARY.md similarity index 97% rename from docs/temp_docs/FINAL_SUMMARY.md rename to docs/temp_docs/caching/CACHE_NAMESPACE_ENDPOINT_FINAL_SUMMARY.md index 7bcb73cc26..cbf7c122d7 100644 --- a/docs/temp_docs/FINAL_SUMMARY.md +++ b/docs/temp_docs/caching/CACHE_NAMESPACE_ENDPOINT_FINAL_SUMMARY.md @@ -111,7 +111,7 @@ curl -X GET https://your-api/obp/v6.0.0/system/cache/namespaces \ ## Documentation - **Full Plan**: `ideas/CACHE_NAMESPACE_STANDARDIZATION.md` -- **Implementation Details**: `IMPLEMENTATION_SUMMARY.md` +- **Implementation Details**: `CACHE_NAMESPACE_IMPLEMENTATION_SUMMARY.md` ## Summary diff --git a/docs/temp_docs/IMPLEMENTATION_SUMMARY.md b/docs/temp_docs/caching/CACHE_NAMESPACE_IMPLEMENTATION_SUMMARY.md similarity index 100% rename from docs/temp_docs/IMPLEMENTATION_SUMMARY.md rename to docs/temp_docs/caching/CACHE_NAMESPACE_IMPLEMENTATION_SUMMARY.md diff --git a/docs/temp_docs/RATE_LIMITING_BUG_FIX.md b/docs/temp_docs/rate-limiting/RATE_LIMITING_BUG_FIX.md similarity index 100% rename from docs/temp_docs/RATE_LIMITING_BUG_FIX.md rename to docs/temp_docs/rate-limiting/RATE_LIMITING_BUG_FIX.md diff --git a/docs/temp_docs/CHANGES_SUMMARY.md b/docs/temp_docs/rate-limiting/RATE_LIMITING_CHANGES_SUMMARY.md similarity index 100% rename from docs/temp_docs/CHANGES_SUMMARY.md rename to docs/temp_docs/rate-limiting/RATE_LIMITING_CHANGES_SUMMARY.md diff --git a/docs/temp_docs/_NEXT_STEPS.md b/docs/temp_docs/rate-limiting/RATE_LIMITING_NEXT_STEPS.md similarity index 100% rename from docs/temp_docs/_NEXT_STEPS.md rename to docs/temp_docs/rate-limiting/RATE_LIMITING_NEXT_STEPS.md diff --git a/docs/temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md b/docs/temp_docs/rate-limiting/REDIS_RATE_LIMITING_DOCUMENTATION.md similarity index 100% rename from docs/temp_docs/REDIS_RATE_LIMITING_DOCUMENTATION.md rename to docs/temp_docs/rate-limiting/REDIS_RATE_LIMITING_DOCUMENTATION.md diff --git a/docs/temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md b/docs/temp_docs/rate-limiting/REDIS_READ_ACCESS_FUNCTIONS.md similarity index 100% rename from docs/temp_docs/REDIS_READ_ACCESS_FUNCTIONS.md rename to docs/temp_docs/rate-limiting/REDIS_READ_ACCESS_FUNCTIONS.md