Getting Started

This guide provides a streamlined path to set up the documentation and explore the API.

Prerequisites

  • Rust toolchain (stable)
  • mdBook for docs: cargo install mdbook mdbook-linkcheck
  • Node.js (optional) for redoc-cli via npx

Build the Docs Locally

make docs-install-tools   # one-time
make docs-serve           # or: mdbook serve --open

API Overview

  • The platform exposes REST endpoints. Health check for providers is documented at: /api/v1/providers/health.
  • See API for details and OpenAPI usage.

Next Steps