Documentation Roadmap
This roadmap tracks documentation that needs to be written for Tenki Cloud. Items are prioritized based on impact and frequency of use.
π¨ Priority 1: Critical Gaps
These affect daily development and operations:
- Environment Variables Reference - Complete list of all env vars
- API Reference - tRPC endpoints and Connect/gRPC services
- GitHub App Setup Guide - Step-by-step installation
- Secrets Management Guide - SOPS usage and key rotation
- Troubleshooting Guide - Common issues and solutions
π§ Priority 2: Configuration & Setup
Essential for proper deployment and configuration:
- Service Configuration Guide - engine.yaml and other configs
- Authentication Setup - Kratos and Keto configuration
- Notification Service Guide - Email and webhook setup
- Database Guide - Schema, migrations, and optimization
- CLI Tool Documentation - tenki-cli command reference
π Priority 3: Operational Excellence
For production operations and monitoring:
- Monitoring & Observability - Metrics, logs, and tracing
- Backup & Restore Procedures - Database and state backup
- Scaling Guidelines - When and how to scale services
- Security Best Practices - Hardening and compliance
- Audit Logging Guide - Event tracking and retention
π Priority 4: Advanced Features
For power users and advanced scenarios:
- Custom Runner Images - Building and managing
- Temporal Workflows Guide - Patterns and testing
- TigerBeetle Integration - Ledger design and reconciliation
- Multi-region Setup - Geographic distribution
- Performance Tuning - Optimization techniques
π Contributing
To add documentation:
- Pick an item from this roadmap
- Create the documentation in the appropriate section
- Update
SUMMARY.mdto include your new page - Remove the item from this roadmap
- Submit a PR
Progress Tracking
- Total items: 24
- Completed: 0
- In Progress: 0
- Remaining: 24
Last updated: 2025-06-12