Documentation Portal

Developer guidance stays tied to real shared contracts.

The developer section starts with the current platform primitives, then points into the first quickstart route instead of hand-waving over the bridge's explicit session and workspace model.

Documentation map

The docs portal stays in the same application as the product shell so setup, deployment, connector, and developer guidance can evolve with the codebase.

In-repo docs7 foundation routes5 developer routesCurrent: Developers

Foundation docs

  • OverviewRoute

    Start with the current architecture, product surfaces, and the stable documentation sections.

  • Getting StartedRoute

    Install the workspace, configure local env files, and run the first verification flow.

  • DeploymentRoute

    Use the managed bridge deployment order, health checks, migrations, and workspace bootstrap flow.

  • ConnectorsRoute

    Understand the Figma reference connector, Satellite runtime, and explicit session routing model.

  • SecurityRoute

    Review auth lanes, workspace isolation, policy controls, rate limiting, and audit semantics.

  • API ReferenceRoute

    Browse the stable HTTP route groups, shared envelopes, auth lanes, and machine-readable errors.

  • TroubleshootingRoute

    Use the current operational failure patterns for readiness, auth, session liveness, policy, and MCP issues.

Developer docs

  • DevelopersOpen

    Developer-facing entry point for HTTP, MCP, connector, and shared-contract guidance.

  • Developer QuickstartRoute

    Bring up the bridge, connect one runtime, and make the first explicit authenticated calls.

  • HTTP GuideRoute

    Use the bridge HTTP transport with the correct auth lane, shared envelopes, and explicit targetSessionId routing.

  • MCP GuideRoute

    Use the Streamable HTTP MCP endpoint, LIST_CAPABILITIES, and the same connector-neutral tool catalog.

  • Connector ModelRoute

    Understand connector definitions, capability metadata, data scopes, and high-risk policy presets.

Platform primitives

External integrators should start from the same explicit concepts that already drive bridge-server, web-client, and product routes.

workspaceIdsessionIdconnectorTypeShared Zod contracts

Cross-boundary payloads live in @uab/shared and should be treated as the platform source of truth.

HTTP and MCP discovery already share the same connector capability metadata rather than maintaining parallel transport-local schemas.

Integrations must preserve explicit session routing. The bridge does not treat any active runtime as interchangeable.

First developer paths

This developer slice now covers orientation, quickstart, HTTP, MCP, and connector-model guidance inside the same route shell.

Developer Quickstart

Bring up the bridge, connect one runtime, and make the first explicit authenticated calls.

Open section

HTTP Guide

Use the bridge HTTP transport with the correct auth lane, shared envelopes, and explicit targetSessionId routing.

Open section

MCP Guide

Use the Streamable HTTP MCP endpoint, LIST_CAPABILITIES, and the same connector-neutral tool catalog.

Open section

Connector Model

Understand connector definitions, capability metadata, data scopes, and high-risk policy presets.

Open section