Documentation

README.md

Acsis Core Documentation

Welcome to the Acsis Core documentation! This documentation follows the Diátaxis framework for clarity and usability.

Documentation Structure

Our documentation is organized into four types, each serving a different purpose:

🎓 Tutorials - Learning-oriented

Step-by-step lessons that take you by the hand through getting started with Dynaplex.

When to use: You're new to Dynaplex and want to learn by doing.

🔧 How-to Guides - Problem-oriented

Practical recipes for solving specific problems and accomplishing tasks.

When to use: You know what you want to do and need step-by-step instructions.

📖 Reference - Information-oriented

Technical descriptions and lookup material for when you need exact details.

Components:

API:

Patterns:

Configuration:

Tools:

When to use: You need to look up specific information, APIs, or configuration.

📐 Architecture Decision Records - Understanding-oriented

Records of key architectural decisions explaining context, options considered, and rationale.

  • ADRs - Browse all architecture decision records

When to use: You want to understand the "why" behind specific design decisions.

⚙️ Operations - Operational guides

Running and maintaining Dynaplex in production.

🚀 Features - Feature-specific documentation

Comprehensive documentation for major features spanning multiple components.

💡 Dynaplex Paradigm - Vision and philosophy

The unified paradigm that makes Dynaplex more than just architecture or tooling.

When to use: You want to understand the Dynaplex paradigm or adopt it in a new project.

Quick Start Paths

🆕 I'm New to Dynaplex

  1. Read Dynaplex Philosophy to understand the paradigm
  2. Review Dynaplex Architecture for component patterns
  3. Follow Getting Started to set up your environment
  4. Build Your First Component to learn the patterns

🔨 I Want to Build Something

  1. Review Component Patterns for best practices
  2. Follow Create a Component step-by-step
  3. Check API Documentation for integration points

🚢 I Need to Deploy

  1. Review Deployment Options
  2. Set up CI/CD Pipeline
  3. Follow Azure Container Apps guide

🐛 I'm Troubleshooting

  1. Check Troubleshooting Guide
  2. Review Build System Reference
  3. Search ADRs for context on design decisions

📚 I Want to Understand Design Decisions

  1. Start with Dynaplex Philosophy for the paradigm vision
  2. Review Dynaplex Architecture for patterns
  3. Read relevant ADRs for specific decisions
  4. Check Agent Infrastructure for coordination tools

Documentation Principles

This documentation follows Diátaxis principles:

  • Tutorials are learning-oriented - they guide beginners through fundamentals
  • How-to guides are goal-oriented - they solve specific problems
  • Reference is information-oriented - it describes the system accurately
  • Explanation is understanding-oriented - it clarifies and provides context

Each type serves a different user need. If you're not sure which to use:

  • Want to learn? → Tutorials
  • Have a task? → How-to Guides
  • Need details? → Reference
  • Want context? → Explanation

Internal Documentation

Team members can find internal documentation in the internal/ folder:

Contributing to Documentation

See Documentation Setup for guidance on:

  • Adding new documentation
  • Following Diátaxis principles
  • Maintaining consistency
  • Using templates

Getting Help

Ready to get started? Begin with Getting Started →