Skip to content

Guides

Page status: scaffold Source state: scaffold Applies to: Shepherd v1.0-dev Owner: @docs-system-owner (TBD) Validation: not yet validated

This is a how-to guide for one job. New to Shepherd? Start with the tutorial. For exact APIs, see the reference.

Scaffold — not yet runnable

This page is a draft against a surface that has not shipped. Treat commands and code as illustrative until the page is promoted.

Guides are task recipes: each does one named job and keeps one shape — job, prerequisites, steps, expected result, and what to do when it fails. They assume you have already met Shepherd (start with the tutorial if not). The guide set is owner-led — curated by hand, not auto-generated — and no guide is promoted until its commands run against shipped surfaces. The planned launch set:

  • Configure a provider
  • Run a workflow
  • Test Shepherd code
  • Route tasks to models
  • Debug your first run

Early drafts of two of these exist as scaffolds in the reviewer build; the launch list itself stays owner-curated and may change before promotion.