README

Timonel Documentation

This wiki documents the current Timonel library and CLI behavior.

Recommended reading order

1. Quick Start
2. Architecture
3. API Reference
4. Type-Safe Helm Helpers
5. Best Practices

Documentation map

Core library

• API Reference
• AWS Resources
• Environment Variables
• Helm Hooks and Lifecycle

Multi-chart applications

• Umbrella Chart Examples
• cdk8s-plus Umbrella Guide
• WordPress + MySQL Pattern

Policy validation

• Policy Engine
• Policy Configuration
• Plugin Development
• Policy Examples

CLI

• CLI Reference
• CLI Simple Chart
• CLI Umbrella Chart

Project maintenance

• Migration Guide
• Contributing
• Release and Versioning

Documentation rules

The wiki follows the same contract as the repository:

• examples favor typed cdk8s/cdk8s-plus constructs;
• public API claims must match generated TypeScript declarations;
• raw YAML APIs are documented as legacy escape hatches;
• generated Helm output is considered product output;
• unsupported external integrations are not presented as built-in Timonel features.

When the wiki and source disagree, the current package declarations and repository source are the source of truth. Please open an issue if you find a mismatch.