diff --git a/.cursor/rules/project.mdc b/.cursor/rules/project.mdc index e660a0c..7e63aa1 100644 --- a/.cursor/rules/project.mdc +++ b/.cursor/rules/project.mdc @@ -3,6 +3,18 @@ description: globs: alwaysApply: true --- -- use UV for package management -- ./docs folder for the documetation and the modules description, update related files if logic changed +# Rule: Project specific rules + +## Goal +Unify the project structure and interraction with tools and console + +### System tools +- **ALWAYS** use UV for package management +- **ALWAYS** use windows PowerShell command for terminal + +### Coding patterns +- **ALWYAS** check the arguments and methods before use to avoid errors with whron parameters or names +- If in doubt, check [CONTEXT.md](mdc:CONTEXT.md) file and [architecture.md](mdc:docs/architecture.md) +- **PREFER** ORM pattern for databases with SQLAclhemy. + diff --git a/.cursor/rules/refactoring.mdc b/.cursor/rules/refactoring.mdc index 1d3e9c4..c141666 100644 --- a/.cursor/rules/refactoring.mdc +++ b/.cursor/rules/refactoring.mdc @@ -24,7 +24,7 @@ Before starting any refactoring, the AI MUST: 1. **Context Analysis:** - Review existing `CONTEXT.md` for architectural decisions - Analyze current code patterns and conventions - - Identify all files that will be affected + - Identify all files that will be affected (search the codebase for use) - Check for existing tests that verify current behavior 2. **Scope Definition:** diff --git a/docs/README.md b/docs/README.md index 79b8888..ca82d91 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,32 +5,32 @@ Welcome to the documentation for the TCP Trading Platform. This resource provide ## Table of Contents ### 1. Project Overview -- **[Project Context (`CONTEXT.md`)]** - The single source of truth for the project's current state, architecture, and conventions. **Start here.** -- **[Product Requirements (`crypto-bot-prd.md`)]** - The Product Requirements Document (PRD) outlining the project's goals and scope. +- **[Project Context (`../CONTEXT.md`)](../CONTEXT.md)** - The single source of truth for the project's current state, architecture, and conventions. **Start here.** +- **[Product Requirements (`./crypto-bot-prd.md`)](./crypto-bot-prd.md)** - The Product Requirements Document (PRD) outlining the project's goals and scope. ### 2. Getting Started -- **[Setup Guide (`guides/setup.md`)]** - Instructions for setting up the development environment. -- **[Contributing (`CONTRIBUTING.md`)]** - Guidelines for contributing to the project. +- **[Setup Guide (`guides/setup.md`)](./guides/setup.md)** - Instructions for setting up the development environment. +- **[Contributing (`CONTRIBUTING.md`)](./CONTRIBUTING.md)** - Guidelines for contributing to the project. ### 3. Architecture & Design -- **[Architecture Overview (`architecture.md`)]** - High-level system architecture, components, and data flow. +- **[Architecture Overview (`../architecture.md`)](../architecture.md)** - High-level system architecture, components, and data flow. - **[Architecture Decision Records (`decisions/`)](./decisions/)** - Key architectural decisions and their justifications. ### 4. Modules Documentation This section contains detailed technical documentation for each system module. - **[Chart System (`modules/charts/`)](./modules/charts/)** - Comprehensive documentation for the modular chart system. -- **[Data Collectors (`modules/data_collectors.md`)]** - Guide to the data collector framework. -- **[Database Operations (`modules/database_operations.md`)]** - Details on the repository pattern for database interactions. -- **[Technical Indicators (`modules/technical-indicators.md`)]** - Information on the technical analysis module. +- **[Data Collectors (`modules/data_collectors.md`)](./modules/data_collectors.md)ะนะน** - Guide to the data collector framework. +- **[Database Operations (`modules/database_operations.md`)](./modules/database_operations.md)** - Details on the repository pattern for database interactions. +- **[Technical Indicators (`modules/technical-indicators.md`)](./modules/technical-indicators.md)** - Information on the technical analysis module. - **[Exchange Integrations (`modules/exchanges/`)](./modules/exchanges/)** - Exchange-specific implementation details. -- **[Logging System (`modules/logging.md`)]** - The unified logging framework. -- **[Data Collection Service (`modules/services/data_collection_service.md`)]** - The high-level service that orchestrates data collectors. +- **[Logging System (`modules/logging.md`)](./modules/logging.md)** - The unified logging framework. +- **[Data Collection Service (`modules/services/data_collection_service.md`)](./modules/services/data_collection_service.md)** - The high-level service that orchestrates data collectors. ### 5. API & Reference -- **[API Documentation (`API.md`)]** - Placeholder for future REST API documentation. +- **[API Documentation (`API.md`)](./API.md)** - Placeholder for future REST API documentation. - **[Technical Reference (`reference/`)](./reference/)** - Detailed specifications, data formats, and standards. -- **[Changelog (`CHANGELOG.md`)]** - A log of all notable changes to the project. +- **[Changelog (`CHANGELOG.md`)](./CHANGELOG.md)** - A log of all notable changes to the project. ## How to Use This Documentation @@ -44,7 +44,7 @@ This documentation is intended to be a living document that evolves with the pro ### ๐Ÿ“– **[Setup & Guides](guides/)** -- **[Setup Guide](guides/setup.md)** - *Comprehensive setup instructions* +- **[Setup Guide](./guides/setup.md)** - *Comprehensive setup instructions* - Environment configuration and prerequisites - Database setup with Docker and PostgreSQL - Development workflow and best practices @@ -52,7 +52,7 @@ This documentation is intended to be a living document that evolves with the pro ### ๐Ÿ“‹ **[Technical Reference](reference/)** -- **[Project Specification](reference/specification.md)** - *Technical specifications and requirements* +- **[Project Specification](./reference/specification.md)** - *Technical specifications and requirements* - System requirements and constraints - Database schema specifications - API endpoint definitions