Skip to content

Commit 80162d7

Browse files
Merge pull request #6 from johnburbridge/refactor/move-docs-to-root
docs: move documentation from package to repository root
2 parents 213a10f + b056375 commit 80162d7

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ A Python package providing two implementations of a time-based storage system fo
2626

2727
Comprehensive documentation is available to help you get the most out of this library:
2828

29-
- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Design principles, implementation details, and performance considerations
30-
- [**Code Examples**](time_based_storage/docs/examples.py) - Practical usage examples and patterns
31-
- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Real-world scenarios for concurrent access
29+
- [**Architecture Guide**](docs/architecture.md) - Design principles, implementation details, and performance considerations
30+
- [**Code Examples**](docs/examples.py) - Practical usage examples and patterns
31+
- [**Concurrent Use Cases**](docs/concurrent_use_cases.md) - Real-world scenarios for concurrent access
3232

3333
The rest of this README provides an overview of installation, basic usage, and API reference.
3434

@@ -167,9 +167,9 @@ This library is well-suited for:
167167

168168
For more detailed information about using this library in various scenarios, see:
169169

170-
- [**Architecture Guide**](time_based_storage/docs/architecture.md) - Learn about the design principles and implementation details
171-
- [**Code Examples**](time_based_storage/docs/examples.py) - See practical examples of how to use the library
172-
- [**Concurrent Use Cases**](time_based_storage/docs/concurrent_use_cases.md) - Explore real-world concurrent access scenarios
170+
- [**Architecture Guide**](docs/architecture.md) - Learn about the design principles and implementation details
171+
- [**Code Examples**](docs/examples.py) - See practical examples of how to use the library
172+
- [**Concurrent Use Cases**](docs/concurrent_use_cases.md) - Explore real-world concurrent access scenarios
173173

174174
## Testing
175175

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)