Project Overview topic

Documentation for analytics_gen

Welcome to the documentation for the analytics_gen package. This folder contains additional guides and reference material that complement the README and the automatically generated API reference.

Contents

• Schema Reference – Complete reference for all YAML fields — every config option, event property, and parameter field with types, defaults, and descriptions.
• Onboarding Guide – How to get started with the package.
• Validation & Naming – Schema validation rules and naming conventions.
• Naming & Configuration – Naming strategies, templates, and casing options.
• Capabilities – Overview of capability keys and provider integration.
• Migration Guides – Steps to migrate existing analytics implementations.
• Code Review Checklist – Checklist for reviewing generated code and docs.
• Testing Guide – Testing patterns for generated analytics APIs and providers.
• Scalability & Performance – Performance considerations for large plans.
• Performance – Detailed optimization tips.
• Troubleshooting – Common errors and fixes.
• AI Prompt Guide – "System prompt" to help LLMs generate valid YAML for you.
• API Reference – Generated Dart API docs on pub.dev.

Studio (Web UI)

Analytics Gen Studio is a visual editor for creating and managing analytics configuration. See the main README for details.

Libraries

analytics_gen

Analytics Gen - Type-safe analytics event tracking with code generation.