Commit Graph

3 Commits

Author SHA1 Message Date
Devin AI
545e1b719d Address comprehensive review feedback: add enhanced error handling, configuration management, version compatibility matrix, and security best practices
- Add PortkeyConfig dataclass for structured configuration management
- Implement comprehensive error handling with custom exception classes
- Add PortkeyLogger for structured logging of Portkey operations
- Include version compatibility matrix with migration guide from legacy patterns
- Add enhanced security practices with environment-based configuration
- Include performance optimization tips with code examples
- Add comprehensive validation and troubleshooting guidance
- All code examples include proper type hints and docstrings
- Focus on technical precision and real-world application patterns

Co-Authored-By: João <joao@crewai.com>
2025-06-03 08:39:30 +00:00
Devin AI
45ceb20cd7 Update Portkey integration documentation
- Modernize integration patterns to use latest Portkey SDK (v1.13.0+)
- Replace deprecated createHeaders/PORTKEY_GATEWAY_URL with direct OpenAI SDK compatibility
- Add comprehensive async support examples
- Enhance multi-LLM provider examples with modern patterns
- Add CrewAI-specific integration patterns for Flows and Memory systems
- Include detailed production reliability features (retries, fallbacks, load balancing)
- Expand observability section with CrewAI-specific metrics and logging
- Add troubleshooting and best practices sections
- Update all code examples with proper imports and error handling
- Improve security features documentation with practical examples

Addresses GitHub issue #2935 - comprehensive update to Portkey AI observability documentation

Co-Authored-By: João <joao@crewai.com>
2025-06-03 08:31:33 +00:00
Tony Kipkemboi
dfc4255f2f docs: Add transparency features for prompts and memory systems (#2902)
* docs: Fix major memory system documentation issues - Remove misleading deprecation warnings, fix confusing comments, clearly separate three memory approaches, provide accurate examples that match implementation

* fix: Correct broken image paths in README - Update crewai_logo.png and asset.png paths to point to docs/images/ directory instead of docs/ directly

* docs: Add system prompt transparency and customization guide - Add 'Understanding Default System Instructions' section to address black-box concerns - Document what CrewAI automatically injects into prompts - Provide code examples to inspect complete system prompts - Show 3 methods to override default instructions - Include observability integration examples with Langfuse - Add best practices for production prompt management

* docs: Fix implementation accuracy issues in memory documentation - Fix Ollama embedding URL parameter and remove unsupported Cohere input_type parameter

* docs: Reference observability docs instead of showing specific tool examples

* docs: Reorganize knowledge documentation for better developer experience - Move quickstart examples right after overview for immediate hands-on experience - Create logical learning progression: basics → configuration → advanced → troubleshooting - Add comprehensive agent vs crew knowledge guide with working examples - Consolidate debugging and troubleshooting in dedicated section - Organize best practices by topic in accordion format - Improve content flow from simple concepts to advanced features - Ensure all examples are grounded in actual codebase implementation

* docs: enhance custom LLM documentation with comprehensive examples and accurate imports

* docs: reorganize observability tools into dedicated section with comprehensive overview and improved navigation

* docs: rename how-to section to learn and add comprehensive overview page

* docs: finalize documentation reorganization and update navigation labels

* docs: enhance README with comprehensive badges, navigation links, and getting started video
2025-05-27 10:08:40 -07:00