Ern Internal Docs

Platform Rules

Engineering workflow, quality gates, and docs conventions

Workflow rules

  • Track feature, bug, and refactor work in Linear.
  • Use branch names from Linear gitBranchName.
  • Do not commit directly to main.
  • Use Conventional Commits with repo scopes.

Quality gates

bun run check
bun run build
bun run test

Run relevant checks before merging. For docs changes, at minimum run:

bunx turbo run check --filter=docs
bunx turbo run build --filter=docs

Internal docs access

  • Internal docs domain: internal.ern.app
  • Access control: Cloudflare Access with @ern.app emails

Documentation template

For each app/package page, keep this structure:

  1. Overview
  2. Architecture
  3. Local development
  4. Environment variables
  5. Deploy and runbook
  6. Ownership

On this page