docs: Update all AI assistant documentation files for v3.2.0

TexasCoding · claude · TexasCoding · commit a7ac607fb99a · 2025-08-17T15:03:41.000-05:00
- Update GEMINI.md, .cursorrules, and GROK.md to match CLAUDE.md
- Set version to v3.2.0 - Enhanced Type Safety Release
- Add standardized deprecation process documentation
- Include Obsidian/external documentation guidelines
- Ensure consistency across all AI assistant files

All AI assistants now have:
- Current v3.2.0 status and features
- Standardized deprecation decorator usage
- Instructions to keep project clean of non-production docs
- Consistent development guidelines

🤖 Generated with Claude Code

Co-Authored-By: Claude &lt;noreply@anthropic.com&gt;
diff --git a/.cursorrules b/.cursorrules
@@ -2,7 +2,7 @@
 
 This file provides guidance to Cursor AI when working with code in this repository.
 
-## Project Status: v3.1.1 - Stable Production Release
+## Project Status: v3.2.0 - Enhanced Type Safety Release
 
 **IMPORTANT**: This project uses a fully asynchronous architecture. All APIs are async-only, optimized for high-performance futures trading.
 
@@ -27,27 +27,62 @@ Example approach:
 - ❌ DON'T: Remove deprecated features without proper notice period
 
 ### Deprecation Process
-1. Mark as deprecated with `warnings.warn()` and `@deprecated` decorator
-2. Document replacement in deprecation message
+1. Use the standardized `@deprecated` decorator from `project_x_py.utils.deprecation`
+2. Provide clear reason, version info, and replacement path
 3. Keep deprecated feature for at least 2 minor versions
 4. Remove only in major version releases (4.0.0, 5.0.0, etc.)
 
 Example:
 ```python
-import warnings
-from typing import deprecated
-
-@deprecated("Use new_method() instead. Will be removed in v4.0.0")
+from project_x_py.utils.deprecation import deprecated, deprecated_class
+
+# For functions/methods
+@deprecated(
+    reason="Method renamed for clarity",
+    version="3.1.14",  # When deprecated
+    removal_version="4.0.0",  # When it will be removed
+    replacement="new_method()"  # What to use instead
+)
 def old_method(self):
-    warnings.warn(
-        "old_method() is deprecated, use new_method() instead. "
-        "Will be removed in v4.0.0",
-        DeprecationWarning,
-        stacklevel=2
-    )
     return self.new_method()
+
+# For classes
+@deprecated_class(
+    reason="Integrated into TradingSuite",
+    version="3.1.14",
+    removal_version="4.0.0",
+    replacement="TradingSuite"
+)
+class OldManager:
+    pass
 ```
 
+The standardized deprecation utilities provide:
+- Consistent warning messages across the SDK
+- Automatic docstring updates with deprecation info
+- IDE support through the `deprecated` package
+- Metadata tracking for deprecation management
+- Support for functions, methods, classes, and parameters
+
+## Development Documentation
+
+### Important: Keep Project Clean - Use External Documentation
+
+**DO NOT create project files for**:
+- Personal development notes
+- Temporary planning documents
+- Testing logs and results
+- Work-in-progress documentation
+- Meeting notes or discussions
+
+**Instead, use**:
+- External documentation tools (Obsidian, Notion, etc.)
+- GitHub Issues for bug tracking
+- GitHub Discussions for architecture decisions
+- Pull Request descriptions for implementation details
+
+This keeps the project repository clean and focused on production code.
+
 ## Development Commands
 
 ### Package Management (UV)
@@ -96,7 +131,7 @@ uv run python -m build       # Alternative build command
 
 ## Project Architecture
 
-### Core Components (v3.0.1 - Multi-file Packages)
+### Core Components (v3.0.2 - Multi-file Packages)
 
 **ProjectX Client (`src/project_x_py/client/`)**
 - Main async API client for TopStepX ProjectX Gateway
diff --git a/GEMINI.md b/GEMINI.md
@@ -2,7 +2,7 @@
 
 This file provides guidance to Google's Gemini models when working with code in this repository.
 
-## Project Status: v3.1.7 - Stable Production Release
+## Project Status: v3.2.0 - Enhanced Type Safety Release
 
 **IMPORTANT**: This project uses a fully asynchronous architecture. All APIs are async-only, optimized for high-performance futures trading.
 
@@ -27,27 +27,83 @@ Example approach:
 - ❌ DON'T: Remove deprecated features without proper notice period
 
 ### Deprecation Process
-1. Mark as deprecated with `warnings.warn()` and `@deprecated` decorator
-2. Document replacement in deprecation message
+1. Use the standardized `@deprecated` decorator from `project_x_py.utils.deprecation`
+2. Provide clear reason, version info, and replacement path
 3. Keep deprecated feature for at least 2 minor versions
 4. Remove only in major version releases (4.0.0, 5.0.0, etc.)
 
 Example:
 ```python
-import warnings
-from typing import deprecated
-
-@deprecated("Use new_method() instead. Will be removed in v4.0.0")
+from project_x_py.utils.deprecation import deprecated, deprecated_class
+
+# For functions/methods
+@deprecated(
+    reason="Method renamed for clarity",
+    version="3.1.14",  # When deprecated
+    removal_version="4.0.0",  # When it will be removed
+    replacement="new_method()"  # What to use instead
+)
 def old_method(self):
-    warnings.warn(
-        "old_method() is deprecated, use new_method() instead. "
-        "Will be removed in v4.0.0",
-        DeprecationWarning,
-        stacklevel=2
-    )
     return self.new_method()
+
+# For classes
+@deprecated_class(
+    reason="Integrated into TradingSuite",
+    version="3.1.14",
+    removal_version="4.0.0",
+    replacement="TradingSuite"
+)
+class OldManager:
+    pass
+```
+
+The standardized deprecation utilities provide:
+- Consistent warning messages across the SDK
+- Automatic docstring updates with deprecation info
+- IDE support through the `deprecated` package
+- Metadata tracking for deprecation management
+- Support for functions, methods, classes, and parameters
+
+## Development Documentation with Obsidian
+
+### Important: Use Obsidian for Development Plans and Progress Tracking
+
+**ALWAYS use Obsidian MCP integration for**:
+- Multi-session development plans
+- Testing procedures and results
+- Architecture decisions and design documents
+- Feature planning and roadmaps
+- Bug investigation notes
+- Performance optimization tracking
+- Release planning and checklists
+
+**DO NOT create project files for**:
+- Personal development notes (use Obsidian instead)
+- Temporary planning documents
+- Testing logs and results
+- Work-in-progress documentation
+- Meeting notes or discussions
+
+### Obsidian Structure for ProjectX Development
+
+When using Obsidian for this project, use the following structure:
+```
+Development/
+  ProjectX SDK/
+    Feature Planning/
+      [Feature Name].md
+    Testing Plans/
+      [Version] Release Testing.md
+    Architecture Decisions/
+      [Decision Topic].md
+    Bug Investigations/
+      [Issue Number] - [Description].md
+    Performance/
+      [Optimization Area].md
 ```
 
+This keeps the project repository clean and focused on production code while maintaining comprehensive development documentation in Obsidian.
+
 ## Development Commands
 
 ### Package Management (UV)
diff --git a/GROK.md b/GROK.md
@@ -7,7 +7,7 @@ This is a Python SDK/client library for the ProjectX Trading Platform Gateway AP
 
 **Note**: Focus on toolkit development, not on creating trading strategies.
 
-## Project Status: v3.1.1 - Stable Production Release
+## Project Status: v3.2.0 - Enhanced Type Safety Release
 
 **IMPORTANT**: This project uses a fully asynchronous architecture. All APIs are async-only, optimized for high-performance futures trading.
 
@@ -32,27 +32,62 @@ Example approach:
 - ❌ DON'T: Remove deprecated features without proper notice period
 
 ### Deprecation Process
-1. Mark as deprecated with `warnings.warn()` and `@deprecated` decorator
-2. Document replacement in deprecation message
+1. Use the standardized `@deprecated` decorator from `project_x_py.utils.deprecation`
+2. Provide clear reason, version info, and replacement path
 3. Keep deprecated feature for at least 2 minor versions
 4. Remove only in major version releases (4.0.0, 5.0.0, etc.)
 
 Example:
 ```python
-import warnings
-from typing import deprecated
-
-@deprecated("Use new_method() instead. Will be removed in v4.0.0")
+from project_x_py.utils.deprecation import deprecated, deprecated_class
+
+# For functions/methods
+@deprecated(
+    reason="Method renamed for clarity",
+    version="3.1.14",  # When deprecated
+    removal_version="4.0.0",  # When it will be removed
+    replacement="new_method()"  # What to use instead
+)
 def old_method(self):
-    warnings.warn(
-        "old_method() is deprecated, use new_method() instead. "
-        "Will be removed in v4.0.0",
-        DeprecationWarning,
-        stacklevel=2
-    )
     return self.new_method()
+
+# For classes
+@deprecated_class(
+    reason="Integrated into TradingSuite",
+    version="3.1.14",
+    removal_version="4.0.0",
+    replacement="TradingSuite"
+)
+class OldManager:
+    pass
 ```
 
+The standardized deprecation utilities provide:
+- Consistent warning messages across the SDK
+- Automatic docstring updates with deprecation info
+- IDE support through the `deprecated` package
+- Metadata tracking for deprecation management
+- Support for functions, methods, classes, and parameters
+
+## Development Documentation
+
+### Important: Keep Project Clean
+
+**DO NOT create project files for**:
+- Personal development notes
+- Temporary planning documents
+- Testing logs and results
+- Work-in-progress documentation
+- Meeting notes or discussions
+
+**Instead, use**:
+- External documentation tools
+- GitHub Issues for bug tracking
+- GitHub Discussions for architecture decisions
+- Pull Request descriptions for implementation details
+
+This keeps the project repository clean and focused on production code.
+
 ## Tool Usage Guidelines
 As Grok CLI, you have access to tools like view_file, create_file, str_replace_editor, bash, search, and todo lists. Use them efficiently for tasks.
 
