Architect Documentation

This folder is the source of truth for Architect's public documentation, published with Mintlify.

How publishing works

• Edit docs here and land changes through the normal monorepo SDLC (branch → PR → merge to master).
• On every push to master that touches docs/** or the published OpenAPI specs, the master-publish-docs GitHub Actions workflow mirrors this folder directly to architect-eng/docs master, which Mintlify deploys.
• Do not edit architect-eng/docs directly — any manual changes there will be overwritten by the next sync.

OpenAPI specs

docs.json references services/*/openapi.yaml paths that do not exist in this folder. Those specs are generated from the monorepo services and injected into the docs repo at publish time:

• architect/services/external-actor-gateway-service/impl/openapi.yaml → services/external-actor-gateway-service/openapi.yaml
• architect/services/egress-webhook-service/impl/openapi.yaml → services/egress-webhook-service/openapi.yaml

To preview API pages locally, copy those specs into a local services/ folder here (it is intentionally not committed).

Local preview

npx mintlify dev

Run from this folder. See AGENTS.md for authoring conventions.