Yggdrasil

Automate anything — traceable plans, reproducible runs.

Yggdrasil is an event-driven orchestration framework that watches different sources (CouchDB, file-system, etc.), routes change events to realm modules, and executes the resulting workflow plans via the Engine.

By audience

I want to…	Where to look
Install Yggdrasil and run it for the first time	Getting Started → Quickstart
Understand configuration files and environment variables	Getting Started → Configuration
Learn the CLI flags and commands	Getting Started → CLI reference
Understand how Yggdrasil works end-to-end	Architecture → Overview
Write a new realm	Realm Authoring → Guide
See common realm patterns	Realm Authoring → Cookbook
Use the Flow API to define steps and plans	Flow API → Overview
Look up terminology	Reference → Glossary
Run test scenarios against the daemon	Reference → Test Realm
Debug a broken setup	Reference → Troubleshooting

Structure

docs/
  getting_started/    install, configure, run
  architecture/       how the pieces fit together
  realm_authoring/    write and register your own realm
  flow_api/           step decorator, planner, engine
  reference/          glossary, test scenarios, troubleshooting