Steward documentation

Concept docs, task-oriented guides, and reference material for Steward — the governance consistency layer for engineering teams. Open Source Software (OSS)-first, works the same on private and internal repos. Pick a starting point below, scan the sidebar for the full table of contents, or search for a specific term.

Get started

Install Steward + your first PR
15-minute walkthrough: install the GitHub App, write a minimal governance.pxf, open a PR, read the verdict.

Concepts

The load-bearing ideas behind Steward. Read these once to read every dashboard and report fluently.

Maintainer guides

Task-oriented walkthroughs for the daily-user persona.

Contributor guides

For the contributor persona — reading your verdict, fixing gate failures, reputation as an author.

Sponsor guides

For the buyer persona — tiers, credit budgets, org membership, audit.

Integrator guides

For the external-integrator persona — using the read-only API from CI, scripts, dashboards.

Reference

Hand-curated reference material with its own route.

API reference
Authentication, scopes, RPC list, rate limits for the read-only HTTP surface.