fix: API_VERSION description

readme.improvement.plan.md

@@ -0,0 +1,117 @@
+# README Improvement Plan
+
+## Priority 1: Critical Missing Information
+
+### 1.1 Environment Variables
+- Add documentation for `DRY_RUN` environment variable and its purpose
+- Document `HOST_TYPE_FILTER_DEFAULT` and `HOST_GROUP_FILTER_DEFAULT` configuration options
+- Explain the difference between `ZABBIX_AUTH_TOKEN` and `ZABBIX_AUTH_TOKEN_FOR_REQUESTS`
+- Add information about `FIND_ZABBIX_EDGE_DEVICE_BASE_GROUP_PREFIX` regex pattern
+
+### 1.2 API Version Information
+- Fix the API version placeholder to properly display the current version
+- Add information about version compatibility between the API and Zabbix server. 
+  - Tested with Zabbix. 7.4
+
+### 1.3 Subscription Clarification
+- Either implement actual subscription operations in the schema or clarify that only infrastructure is provided
+- If only infrastructure is provided, update the feature description to be more accurate
+
+## Priority 2: Enhance Existing Sections
+
+### 2.1 Architecture Section
+- Add an architecture diagram or detailed explanation based on AGENTS.md
+- Include information about the data flow between components
+- Explain the role of each DataSource file in the datasources directory
+
+### 2.2 Configuration Section
+- Add a complete table of all environment variables with descriptions
+- Include default values and required/optional status
+- Add examples of production vs development configurations
+
+### 2.3 Schema Relationship Section
+- Create a mapping table between Zabbix entities and GraphQL types
+- Explain how Zabbix host groups, templates, and items relate to GraphQL objects
+- Add information about the Location type and its usage
+
+## Priority 3: Add New Sections
+
+### 3.1 Code Generation Section
+- Explain the GraphQL Codegen setup and how to regenerate types
+- Document the `codegen.ts` configuration
+- Add instructions for updating generated types after schema changes
+
+### 3.2 Troubleshooting Section
+- Common connection issues with Zabbix server
+- Authentication problems and solutions
+- Schema extension troubleshooting
+- Performance issues and optimizations
+
+### 3.3 Security Best Practices
+- Recommended authentication approaches
+- Permission system best practices
+- Network security considerations
+- API rate limiting and protection
+
+### 3.4 Performance and Scaling
+- Performance considerations for large Zabbix installations
+- Caching strategies
+- Connection pooling recommendations
+- Monitoring and observability setup
+
+### 3.5 Backup and Recovery
+- Configuration backup procedures
+- Schema migration guidelines
+- Disaster recovery procedures
+
+## Priority 4: Improve Examples
+
+### 4.1 Complete Examples
+- Add more complete examples for each major operation
+- Include error handling examples
+- Add examples for common use cases beyond the distance tracker
+
+### 4.2 Testing Examples
+- Add information about how to run tests
+- Include examples of unit and integration tests
+- Explain the test structure and how to add new tests
+
+## Priority 5: Documentation Links
+
+### 5.1 Cross-Reference Improvements
+- Add links to relevant sections in schema files
+- Include references to specific resolver implementations
+- Link to related documentation files in the docs directory
+
+### 5.2 External Resources
+- Link to official Zabbix API documentation
+- Include references to Apollo Server documentation
+- Add links to GraphQL best practices
+
+## Priority 6: Maintenance Items
+
+### 6.1 Update Placeholder Values
+- Replace all "your-" placeholder values with more descriptive examples
+- Add realistic example values for configuration parameters
+- Include sample output where appropriate
+
+### 6.2 Version Compatibility Matrix
+- Create a matrix showing compatibility between API versions and Zabbix versions
+- Include Node.js version compatibility information
+- Add information about breaking changes between versions
+
+## Implementation Order
+1. Address Priority 1 items first (critical missing information)
+2. Update existing sections to be more accurate
+3. Add new sections incrementally
+4. Enhance examples with more practical use cases
+5. Add documentation links and cross-references
+6. Perform final review and testing of all examples
+
+## Success Metrics
+- All environment variables documented
+- Accurate representation of features
+- Complete working examples
+- Clear architecture and configuration guidance
+- Comprehensive troubleshooting information
+- Proper cross-references to codebase