From 0e75fbda66e860f076e652203e1435725c1d37be Mon Sep 17 00:00:00 2001 From: Ajasra Date: Sat, 7 Jun 2025 14:18:58 +0800 Subject: [PATCH] docs --- CHANGELOG.md | 21 --------------------- README.md | 8 ++++---- 2 files changed, 4 insertions(+), 25 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 6446474..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,21 +0,0 @@ -# Changelog - -## [Unreleased] - -### Added -- New safety limits system for trade transformations -- Comprehensive validation for trade sizes and prices -- Stablecoin-specific trading limits -- Market price deviation checks -- Detailed logging for approaching limits - -### Changed -- Refactored transformation module for better modularity -- Split trade transformation logic into dedicated classes -- Enhanced error messages with more context -- Improved symbol format validation - -### Fixed -- Trade side normalization no longer defaults to 'buy' -- Added missing validation for trade notional values -- Fixed potential floating-point precision issues using Decimal \ No newline at end of file diff --git a/README.md b/README.md index 5384224..40ae484 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,10 @@ uv run python main.py All project documentation is located in the `docs/` directory. The best place to start is the main documentation index. -- **[Main Documentation (`docs/README.md`)]** - The central hub for all project documentation, including setup guides, architecture, and module details. -- **[Setup Guide (`docs/guides/setup.md`)]** - Complete setup instructions for new machines. -- **[Project Context (`CONTEXT.md`)]** - The single source of truth for the project's current state. +- **[Main Documentation](`docs/README.md`)** - The central hub for all project documentation, including setup guides, architecture, and module details. +- **[Setup Guide](`docs/guides/setup.md`)** - Complete setup instructions for new machines. +- **[Project Context](`CONTEXT.md`)** - The single source of truth for the project's current state. ## Contributing -We welcome contributions! Please review the **[Contributing Guidelines (`docs/CONTRIBUTING.md`)]** and the **[Project Context (`CONTEXT.md`)]** before getting started. +We welcome contributions! Please review the **[Contributing Guidelines](`docs/CONTRIBUTING.md`)** and the **[Project Context](`CONTEXT.md`)** before getting started.