WordloopGuides
Task-oriented how-tos for the operations that come up most often on Wordloop.
Guides
Guides are task-oriented: each one walks you through completing a specific goal, from first command to verification. They assume you already know roughly why you want to do the thing; if you do not, follow the links into Learn or Engineering Principles from inside the guide.
Developer workflow
Add an API Endpoint
From OpenAPI spec to generated handler to passing test.
Add a Service
Scaffold a new microservice that plugs into gateway, observability, and CI.
Run Tests
Unit, integration, and system tests — how to run them locally and read their output.
Migrate the Schema
Write, review, and apply a Postgres migration with zero downtime.
Deploy
Trigger a build, watch the canary, promote to production.
Code Generation
Regenerate clients, types, and handlers from /specs.
How to read a guide
Every guide is structured the same way: Goal → Prerequisites → Steps → Verification → Troubleshooting. If you find a step that fails in a way the guide does not cover, treat that as a bug in the documentation and open a PR against the guide itself — see Your First Contribution.