Skip to content

Documentation Structure

This directory contains focused documentation for causaliq-workflow development.

Essential Documents

📋 Start Here

  • Development Roadmap - Complete feature list, progress tracking, and three-month implementation plan
  • Example Workflows - Series-based workflow examples and YAML configuration patterns

🔧 Design

  • Technical Architecture - System design, Series concept, component architecture, and workflow-specific development patterns

📖 Development Support

  • LLM Development Guide - Comprehensive development standards and LLM communication patterns for the CausalIQ ecosystem

Quick Navigation

For Design Work

Start with: Technical Architecture → Development Roadmap

For Understanding Requirements

Start with: Development Roadmap → Example Workflows

For LLM Collaboration

Use: LLM Development Guide (comprehensive, ecosystem-wide standards)

Document Purpose Summary

Document Purpose When to Use
roadmap.md Feature specifications and progress tracking Feature development planning
example_workflows.md YAML workflow examples Understanding series concept
technical_architecture.md Package architecture and design patterns Building components

This streamlined structure focuses on actionable implementation guidance while maintaining single sources of truth.