commflow
  • English

      • Documentation Index

      This page separates the user path for what runs today from the path for planned product APIs, so you can verify the release before reading complete future workflows.

      Current Release 0.0.2

      PageWhen to read
      Current Release Quick StartInstall and run the currently released manifest API.
      Manifest APILook up released exports, fields, and descriptor values.
      Transport MapCheck the boundary between the manifest and planned runtimes.
      TroubleshootingFix current-version, import, Node version, and unreleased API expectation issues.

      Planned APIs: Product Guide

      PageWhen to read
      Product Guide (Planned APIs)Understand the planned complete feature scope, unified model, and feature choice.
      Feature OverviewChoose request, SSE, RPC, socket, or VextJS adapter for future adoption.

      Planned APIs: Core Communication Features

      PageWhen to read
      RequestSend HTTP requests and configure timeout/retry, targets, context, and hooks.
      SSESubscribe to server events, handle messages, reconnect, close, and cleanup.
      RPCCall services by procedure, pass arguments, handle returns, and use typed contracts.
      SocketEstablish long-lived connections, send messages, listen, heartbeat, reconnect, and close.

      Planned APIs: Configuration And Errors

      PageWhen to read
      ConfigurationLook up timeout, retry, headers, targets, contextProvider, and hooks.
      Errors And RetriesUnderstand HTTP status, timeout, network, aborted, hook failure, retry, and reconnect boundaries.

      VextJS: Current Option & Planned Adoption

      PageWhen to read
      VextJS AdoptionUse app.fetch.create() + app.extend() for a client today and review the planned adapter compatibility path.

      Design Preview

      PageWhen to read
      Request Design DraftReview unsettled request API sketches; the planned product guide lives in Request.
      1. Current Release Quick Start
      2. Manifest API
      3. Transport Map
      4. Troubleshooting
      5. Product Guide (Planned APIs)
      6. Feature Overview
      7. Request
      8. SSE
      9. RPC
      10. Socket
      11. Configuration
      12. Errors And Retries
      13. VextJS Adoption