Skip to content

Engineering rules

Repository conventions and the definition of done.

Repository

StackShip is a pnpm workspace orchestrated with Turborepo. Applications live in apps/; shared libraries belong in packages/.

Each production surface has its own Worker and Wrangler configuration. Custom domains are explicit in source control.

Definition of done

A product change is done only when:

  1. The implementation is type-safe and passes its local checks.
  2. Relevant tests or protocol probes pass.
  3. User-facing behavior and operational changes are documented in Nimbus.
  4. New configuration is represented in .env.example or deployment docs.
  5. No privileged credential is committed.
  6. Production health is checked after deployment.

Documentation workflow

Write documentation alongside implementation. Use apps/docs/src/content/docs/ for pages and apps/docs/src/content/partials/ for shared sections. Run:

pnpm --filter @stackship/docs check

Nimbus publishes clean Markdown alternates and agent indexes. Treat broken internal links or invalid frontmatter as build failures.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close