Skip to main content
Type: ExplanationCreated: Last reviewed: Team: Platform
published
Skapp Engineering Docs

The handbook for how we build Skapp.

Five sections, one source of truth. Everything you need to write, understand, and operate Skapp lives here.

HandbookEngineeringSystemOperationsReference

The five sections

Pick the area, browse from there.

Handbook

How we write, structure, and ship docs.

  • Fill the Frontmatter
  • Pick the Right Doc Type
  • Templates
  • Markdown Features
Browse all

Engineering

How we code, test, review, and ship.

  • Onboarding
  • Code review
  • Testing
  • Git workflow
Browse all

System

What we built — architecture, modules, integrations.

  • Architecture
  • Modules
  • Integrations
  • Internal tools
Browse all

Operations

Running it — on-call, incidents, runbooks, SLOs.

  • On-call
  • Incidents
  • Runbooks
  • Postmortems
Browse all

Reference

Flat lookups — APIs, errors, config, glossary.

  • Glossary
  • API reference
  • Error codes
  • Config keys
Browse all

Find your path

Pick what you're trying to do — we'll point you to the right starting points.

Day one. Get oriented and ship your first PR.

  1. 1Read the welcomeWhat Skapp is and how the team operates.
  2. 2Set up your dev environmentTools, repos, accounts, access.
  3. 3Learn our git workflowBranching, PRs, commit conventions.
  4. 4Tour the architectureA high-level map before you go deep.

Recently updated

The freshest docs across the handbook.

Loading…

Doc types we use

Pick the right shape before you write. Click a type to open its template.

Tutorial
Learning-oriented. Walk a beginner through a working example.
How-to
Task-oriented. A recipe for one specific outcome.
Explanation
Understanding-oriented. The why and how it fits together.
Reference
Lookup-oriented. Authoritative facts you scan, not read.
Runbook
Operational. Step-by-step playbook for a known incident.
Postmortem
Retrospective. What happened, why, what changes.
ADR
Architecture decision. Context, choice, consequences. Append-only.

Couldn't find what you need?

Search every docAsk the chatbotOpen the glossary