Skip to content

unionai/unionai-docs

Repository files navigation

Flyte and Union.ai documentation

This repository holds all documentation for the Flyte OSS project and the Union.ai products.

Repository structure

The docs system uses three repositories:

  • unionai-docs (this repo) — version-specific content (content/, data/, linkmap/, include/), configuration (api-packages.toml, makefile.inc), and CI workflows.
  • unionai-docs-infra (submodule within unionai-docs at unionai-docs-infra/) — shared build infrastructure: Hugo config, layouts, themes, Python tools, scripts, and redirect data. Identical across main (v2) and v1 branches.
  • unionai-examples (submodule within unionai-docs at unionai-examples/), contains example code referenced by the docs.

Quick start

# Clone with submodules
git clone --recurse-submodules https://github.com/unionai/unionai-docs.git
cd unionai-docs

# Set up local config
cp unionai-docs-infra/hugo.local.toml~sample hugo.local.toml

# Start dev server at localhost:1313
make dev

Requires Hugo >= 0.145.0 (brew install hugo).

Further reading

  • unionai-docs-infra/README.md — comprehensive build system documentation (local dev, production builds, CI checks, Cloudflare deployment, LLM docs pipeline).
  • Contributing docs and examples — authoring guide, shortcodes, variants, API docs (source at content/community/contributing-docs/).

About

The Flyte and Union documentation site

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors