# Project IronFlow documentation index
# Fetch this file for a sitemap of published pages.
# Site: https://pppsdavid.github.io/rust-based-prefect
# Markdown source: append paths to the GitHub docs/ tree below.

- Home: https://pppsdavid.github.io/rust-based-prefect
  Layered doc home and onboarding paths.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/index.md

- Installation (PyPI · pip / uv): https://pppsdavid.github.io/rust-based-prefect/INSTALL/
  Primary install path from PyPI wheels.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/INSTALL.md

- Quick start: PyPI (no clone): https://pppsdavid.github.io/rust-based-prefect/QUICKSTART_PYPI/
  Minimal in-process flow after pip install.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/QUICKSTART_PYPI.md

- Quick start (demo flow): https://pppsdavid.github.io/rust-based-prefect/QUICKSTART_DEMO/
  Repo demo with bundled example script.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/QUICKSTART_DEMO.md

- Quickstart: first deployment: https://pppsdavid.github.io/rust-based-prefect/quickstart-first-deployment/
  Install → API → ironflow deploy → trigger run.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/quickstart-first-deployment.md

- Self-hosted server: https://pppsdavid.github.io/rust-based-prefect/SELF_HOSTED_SERVER/
  API, workers, deployments, scheduling.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/SELF_HOSTED_SERVER.md

- Verify the web UI: https://pppsdavid.github.io/rust-based-prefect/ui_e2e_visual_check/
  Visual checklist for the optional Vite UI.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/ui_e2e_visual_check.md

- Concepts overview: https://pppsdavid.github.io/rust-based-prefect/concepts/
  Flows, tasks, runners, states, DAG.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/index.md

- Flows: https://pppsdavid.github.io/rust-based-prefect/concepts/flows/
  @flow decorator and flow runs.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/flows.md

- Tasks: https://pppsdavid.github.io/rust-based-prefect/concepts/tasks/
  @task, submit, map, futures.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/tasks.md

- Runners: https://pppsdavid.github.io/rust-based-prefect/concepts/runners/
  Task runners and concurrent map.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/runners.md

- DAG and forecast: https://pppsdavid.github.io/rust-based-prefect/concepts/dag-and-forecast/
  Static planner and run DAG.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/dag-and-forecast.md

- States and transitions: https://pppsdavid.github.io/rust-based-prefect/concepts/states-and-transitions/
  RunState and Rust FSM edges.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/concepts/states-and-transitions.md

- Prefect → IronFlow: https://pppsdavid.github.io/rust-based-prefect/PREFECT_IRONFLOW_MAPPING/
  Concept mapping from Prefect 3.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/PREFECT_IRONFLOW_MAPPING.md

- Architecture: https://pppsdavid.github.io/rust-based-prefect/architecture/
  Python shim, Rust engine, persistence.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/architecture.md

- How-to overview: https://pppsdavid.github.io/rust-based-prefect/how-to/
  Task-focused guides index.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/index.md

- How to set up IronFlow: https://pppsdavid.github.io/rust-based-prefect/how-to/setup/
  Clone, env, cargo build, env vars.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/setup.md

- How to run the server and UI: https://pppsdavid.github.io/rust-based-prefect/how-to/server-and-ui/
  ironflow_server.py and manual uvicorn.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/server-and-ui.md

- How to run the server in Docker: https://pppsdavid.github.io/rust-based-prefect/how-to/docker-quickstart/
  Single-container API image and volumes.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/docker-quickstart.md

- How to run IronFlow with Docker Compose: https://pppsdavid.github.io/rust-based-prefect/how-to/docker-compose/
  Postgres + API + services + HTTP workers.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/docker-compose.md

- How to run background services: https://pppsdavid.github.io/rust-based-prefect/how-to/run-background-services/
  ironflow server services start without HTTP.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/run-background-services.md

- How to use Postgres for the control plane: https://pppsdavid.github.io/rust-based-prefect/how-to/database-postgres/
  IRONFLOW_DATABASE_URL and Rust claim bind.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/database-postgres.md

- How to run workers in HTTP mode: https://pppsdavid.github.io/rust-based-prefect/how-to/worker-http-mode/
  HTTP claim API; no shared DB volume.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/worker-http-mode.md

- How to secure a self-hosted server: https://pppsdavid.github.io/rust-based-prefect/how-to/secure-self-hosted/
  HTTP Basic auth via IRONFLOW_*_AUTH_STRING.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/secure-self-hosted.md

- How to deploy with CLI: https://pppsdavid.github.io/rust-based-prefect/how-to/deploy-with-cli/
  ironflow.yaml and ironflow CLI.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/deploy-with-cli.md

- How to create deployments: https://pppsdavid.github.io/rust-based-prefect/how-to/deployments/
  HTTP API deployment recipes.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/deployments.md

- How to compose flows with subflows: https://pppsdavid.github.io/rust-based-prefect/how-to/subflows/
  Inline and deployment-backed subflows.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/subflows.md

- How to choose a task runner: https://pppsdavid.github.io/rust-based-prefect/how-to/choose-task-runners/
  Thread vs process vs sequential for map().
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/choose-task-runners.md

- How to use concurrency limits: https://pppsdavid.github.io/rust-based-prefect/how-to/concurrency-limits/
  Global slots, rate_limit, and tag caps.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/concurrency-limits.md

- How to resume tasks and persist results: https://pppsdavid.github.io/rust-based-prefect/how-to/task-resume-and-persist/
  DAG resume on retry, persist_result, JSON allowlist.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/task-resume-and-persist.md

- How to port from Prefect: https://pppsdavid.github.io/rust-based-prefect/how-to/port-from-prefect/
  Import swap and subset limits.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/how-to/port-from-prefect.md

- Compatibility matrix: https://pppsdavid.github.io/rust-based-prefect/compatibility/
  Supported vs unsupported Prefect semantics.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/compatibility.md

- Environment variables: https://pppsdavid.github.io/rust-based-prefect/reference/env-vars/
  All IRONFLOW_* variables.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/reference/env-vars.md

- REST API overview: https://pppsdavid.github.io/rust-based-prefect/reference/api/
  HTTP route index.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/reference/api.md

- Troubleshooting: https://pppsdavid.github.io/rust-based-prefect/reference/troubleshooting/
  Common install and server issues.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/reference/troubleshooting.md

- Performance (vs Prefect): https://pppsdavid.github.io/rust-based-prefect/PERFORMANCE_OVERVIEW/
  Control-plane throughput expectations.
  markdown: https://github.com/PPPSDavid/rust-based-prefect/blob/main/docs/PERFORMANCE_OVERVIEW.md