README.md

User documentation

Documentation for administrators, integrators, and end users of Nexus Gateway.

Contents

• product/ — what Nexus is and how it is deployed:
  • overview.md — product overview and positioning.
  • features.md — the capability matrix.
  • architecture.md — the user-facing architecture.
  • deployment-models.md — SaaS, self-hosted, and air-gapped.
• features/ — per-surface feature guides:
  • cp-ui/ — one guide per Control Plane console section.
  • agent-ui/ — one guide per Desktop Agent dashboard page.
• api/ — OpenAPI specifications:
  • api/openapi/ — OpenAPI 3.1 YAML files per epic/story (Control Plane admin API, AI Gateway /v1 surface).

For the full documentation map, see docs/README.md.