Skip to content

Release & Developer Experience #16

Description

@ggondim

Summary

Polish for public release: packaging, deployment, observability, and documentation.

Tasks

Packaging & Deployment

  • Docker image published to GHCR
  • docker compose production profile
  • Helm chart for Kubernetes deployment
  • npx create-openthreads or bun create openthreads scaffold

Observability

  • Structured JSON logging (configurable log level)
  • Metrics endpoint (Prometheus-compatible): messages in/out, active threads, response latency, A2H intent counts
  • OpenTelemetry traces for request flows (inbound → route → outbound → reply)

Documentation

  • API reference (OpenAPI spec auto-generated from routes)
  • Channel setup guides (per platform)
  • Self-hosting guide (Docker, env vars, MongoDB setup)
  • Custom adapter authoring guide (ChannelAdapter interface)
  • Custom storage adapter guide (StorageAdapter interface)

Examples

  • Example: n8n integration (webhook consumer)
  • Example: LangGraph integration
  • Example: plain HTTP webhook consumer (curl-level)

A2H Layer 2 Preparation

  • Stub types for Layer 2 intents: POLICY, REVOKE, DELEGATE, SCOPE
  • Extension point in Reply Engine for future intent handlers
  • Monitor twilio-labs/a2h-spec for Layer 2 stabilization

Acceptance Criteria

  • docker compose up starts a fully working OpenThreads instance
  • Helm chart deploys to a Kubernetes cluster
  • OpenAPI spec is auto-generated and accessible at /api/docs
  • All example integrations work end-to-end
  • Prometheus metrics endpoint returns meaningful data

Dependencies

References

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions