Introduction
Getting started
Use this guide as the source of truth for onboarding, release controls, and production-ready operation.
Installation
Step-by-step setup for local development and CI pipelines.
Architecture guide
Understand how Pie services, workers, and docs tooling interact.
Release workflow
Move from draft to production with verification checkpoints.
API reference
Method-level contracts and operational notes for each endpoint.
Learn how to set up Pie in your environment and ship predictable releases with minimal friction.
Quick start
Start with the smallest viable install path. These commands create a workspace, validate config, and boot local docs.
Installing dependencies
npm install -g @pie/cli pie init --template docs pie docs dev
Environment check required
Run pie doctor before your first deployment to confirm runtime versions, network endpoints, and credential scopes.
Configuring the project
// pie.config.ts
export default {
docs: {
source: './docs',
strictLinks: true,
},
release: {
channel: 'stable',
verification: ['lint', 'build', 'smoke'],
},
}
Keep config deterministic
Pin tool versions and avoid environment-specific branches in configuration files. Consistency is the easiest reliability win.
Basic usage
Your first deployment
Use a CI pipeline that runs docs linting, builds static output, and only then pushes to your deployment environment.
Managing operational changes
Track every schema, API, and content change in your release note. This keeps support, QA, and engineering aligned on runtime behavior.
Rollback strategy
Prepare a rollback command and validate it quarterly. Fast rollback is part of release quality, not just incident response.
API reference
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/pies | List pie entities with pagination support. |
| POST | /api/v1/pies | Create a pie entity from validated payload. |
| PATCH | /api/v1/pies/{id} | Apply partial updates and store audit metadata. |
| DELETE | /api/v1/pies/{id} | Archive a pie entity using soft-delete semantics. |
Operations
Monitoring
Export request latency, response codes, and queue depth to a shared dashboard. Alert on trends, not single spikes.
Security controls
Rotate deployment credentials regularly and store tokens in managed secrets only.
Support workflow
Use issue templates with exact reproduction data so on-call engineers can triage quickly.