From b0b6f871eba5dad1498763dc3bff2c6905169a7a Mon Sep 17 00:00:00 2001 From: John Burbridge Date: Fri, 21 Mar 2025 12:16:08 -0700 Subject: [PATCH 1/2] docs: move documentation from package to repository root --- {time_based_storage/docs => docs}/architecture.md | 0 {time_based_storage/docs => docs}/concurrent_use_cases.md | 0 {time_based_storage/docs => docs}/examples.py | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename {time_based_storage/docs => docs}/architecture.md (100%) rename {time_based_storage/docs => docs}/concurrent_use_cases.md (100%) rename {time_based_storage/docs => docs}/examples.py (100%) diff --git a/time_based_storage/docs/architecture.md b/docs/architecture.md similarity index 100% rename from time_based_storage/docs/architecture.md rename to docs/architecture.md diff --git a/time_based_storage/docs/concurrent_use_cases.md b/docs/concurrent_use_cases.md similarity index 100% rename from time_based_storage/docs/concurrent_use_cases.md rename to docs/concurrent_use_cases.md diff --git a/time_based_storage/docs/examples.py b/docs/examples.py similarity index 100% rename from time_based_storage/docs/examples.py rename to docs/examples.py From b0563756f26899d3ab7305097e6f55e05dd07cf1 Mon Sep 17 00:00:00 2001 From: John Burbridge Date: Fri, 21 Mar 2025 12:21:58 -0700 Subject: [PATCH 2/2] docs: update documentation links in README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d35eb61..11913ad 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ A Python package providing two implementations of a time-based storage system fo Comprehensive documentation is available to help you get the most out of this library: -- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Design principles, implementation details, and performance considerations -- [**Code Examples**](time_based_storage/docs/examples.py) - Practical usage examples and patterns -- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Real-world scenarios for concurrent access +- [**Architecture Guide**](docs/architecture.md) - Design principles, implementation details, and performance considerations +- [**Code Examples**](docs/examples.py) - Practical usage examples and patterns +- [**Concurrent Use Cases**](docs/concurrent_use_cases.md) - Real-world scenarios for concurrent access The rest of this README provides an overview of installation, basic usage, and API reference. @@ -167,9 +167,9 @@ This library is well-suited for: For more detailed information about using this library in various scenarios, see: -- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Learn about the design principles and implementation details -- [**Code Examples**](time_based_storage/docs/examples.py) - See practical examples of how to use the library -- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Explore real-world concurrent access scenarios +- [**Architecture Guide**](docs/architecture.md) - Learn about the design principles and implementation details +- [**Code Examples**](docs/examples.py) - See practical examples of how to use the library +- [**Concurrent Use Cases**](docs/concurrent_use_cases.md) - Explore real-world concurrent access scenarios ## Testing