From beb2efb94668a56c473d09be7743c295a0f2e8e5 Mon Sep 17 00:00:00 2001 From: Ojietohamen Samuel Date: Sat, 3 Aug 2024 11:28:17 +0100 Subject: [PATCH] updated docs README --- docs/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index cdd4dd3..706cd43 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,15 +14,16 @@ Here's a quick overview of the available documentation: - **[Flow](flow.md):** Core logic and workflow of the TradeFlow system. - **[Folder Structure](folder_structure.md):** Describes the project's folder structure and organization. -**Additional Documentation:** - - **[Interfaces](interfaces.md):** Information about the interfaces used within the project. - **[Data Repositories](repositories.md):** Documentation for the data repositories used in TradeFlow. -- **[Resources](resources.md):** Additional resources or references for users. - **[Venues](venues.md):** Details about the integration with different trading venues. **Images:** - **[Images folder](./images/)**: Contains any images or diagrams used within the documentation. +**Additional Resources:** + +- **[Resources](resources.md):** Additional resources or references for users. + The documentation serves as a comprehensive guide for developers, users, and contributors to understand the TradeFlow project. It provides clear explanations, examples, and instructions for various aspects of the system.