Skip to content
Welcome

AI Orchestrator — Documentation

Reference content for the docs site at docs.hivedeploy.in. Every doc fits one of four Diátaxis types.

Start here

How-to guides (task-oriented)

Reference (information-oriented)

Explanation (understanding-oriented)

Troubleshooting


Conventions used in these docs

  • Code blocks with language tags get syntax highlighting in the rendered docs (bash, yaml, python, tsx, etc.)
  • Inline code for env var names, file paths, function names
  • > Note: callouts for important info
  • > Watch out: callouts for common mistakes
  • Headings use Title Case; the doc title is # Page Title (single H1)
  • Every page declares its Diátaxis type in the header (Tutorial / How-to / Reference / Explanation)
  • Examples use real values from the platform (real region IDs, real agent names) — not <placeholder> syntax unless absolutely necessary

What’s intentionally NOT here

  • Internal architecture documentation — that lives in docs/superpowers/specs/ and docs/superpowers/plans/ in the monorepo. Customer-facing docs should never expose internal feature-flag names or implementation details.
  • Marketing pages — the docs site is for users who already signed up. Pre-signup content lives on the landing page.
  • Sales / pricing details — those change too often; link to the pricing page rather than mirroring.

Maintenance

  • When a feature ships, add or update the relevant doc in this folder in the same PR. Code without docs is half-done.
  • When a customer hits a confusing error and contacts support, add it to troubleshooting/common-errors.md so the next customer self-serves.
  • When a competitor’s customer asks “do you do X?”, add an explanation doc covering it — half the time that becomes the deciding factor on the trial.