Skip to content

Codespaces onboarding friction: missing docs generation + unclear multi-service startup #3993

@Saptami191

Description

@Saptami191

I was onboarding Hatchet in GitHub Codespaces and ran into a few developer experience/setup issues that made the local startup flow difficult to understand.

Environment:

  • GitHub Codespaces
  • frontend/app via pnpm dev
  • Docker infra started successfully
  • Go services started manually

Issues encountered:

  1. Missing generated docs dependency
    Frontend initially failed with:
    Failed to resolve import "@/lib/generated/docs"

This required manually discovering and running:
pnpm docs:gen

It was not obvious during frontend setup.

  1. Multi-service startup flow unclear
    The frontend depends on:
  • API service on :8080
  • control-plane/engine service on :8081

Initially only the API was started, which caused repeated:
ECONNREFUSED 127.0.0.1:8081

It wasn’t immediately clear which binaries/services needed to run together for local development.

  1. Codespaces / forwarded-port auth friction
    Cookie domain configuration caused auth/session issues in Codespaces forwarded URLs. The default local cookie-domain assumptions seem optimized for local machine domains rather than cloud dev environments.

Suggestions:

  • add a dedicated Codespaces onboarding section
  • document required startup order for local development
  • explicitly mention pnpm docs:gen
  • provide a single local-dev startup command/script if possible
  • clarify which services map to ports 8080 and 8081

Core infrastructure itself worked correctly:

  • Postgres
  • RabbitMQ
  • migrations
  • API
  • engine

This issue is mainly about onboarding clarity and local DX.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions