---
schema: formation.doc/v0.1
kind: doc
visibility: public
canonical_url: https://topologyindex.com/docs/schemas/guide/v0.1.md
document_kind: guide
document_schema: formation.guide/v0.1
path: /docs/schemas/guide/v0.1.md
product_api_version: v1
schema_version: v0.1
title: formation.guide/v0.1
---

# formation.guide/v0.1

Frontmatter fields of a `guide` page. This service publishes these pages and never
accepts one, so the schema is a promise about what it serves: its tests check every page
against it. Prose in the body explains; the frontmatter is what to read.

## Fields

- `schema` (required): exactly `formation.guide/v0.1`
- `kind` (required): exactly `guide`
- `visibility` (required): exactly `public`
- `path` (required): resource path, pattern `^\/[A-Za-z0-9._~/-]{0,255}$`, at most 256 characters
- `canonical_url` (required): https URL, pattern `^https:\/\/[A-Za-z0-9.-]+(?:\/\S*)?$`, at most 512 characters
- `product_api_version` (required): API version, pattern `^v\d{1,4}$`, at most 5 characters
- `schema_version` (required): schema version, pattern `^v\d{1,4}\.\d{1,4}$`, at most 11 characters
- `title` (required): title, pattern `^[^\p{Cc}]+$`, at most 200 characters
- `description` (required): description, pattern `^[^\p{Cc}]+$`, at most 400 characters
- `guide` (required): guide identifier, pattern `^[a-z0-9]+(?:-[a-z0-9]+)*$`, at most 64 characters. Identifier of the guide; its page is `/guides/{guide}.md`.
- `also_known_as` (required): array of 0 to 16 items, each phrase, pattern `^[^\p{Cc}]+$`, at most 96 characters. Other phrases for the topic of the guide, as people search for it. Not a vocabulary.
- `families` (required): array of 1 to 7 items, each map (fields listed below). Every pattern family and its patterns, in vocabulary order, as on `/patterns/index.md`; each pattern page is `/patterns/{pattern}.md`. Never a ranking.
- `families[].family` (required): one of `baseline`, `parallelism`, `hierarchy`, `shared_state`, `verification`, `adaptive`, `continuity`
- `families[].patterns` (required): array of 1 to 23 items, each one of `single_agent`, `fan_out`, `map_reduce`, `independent_workers`, `lane_swarm`, `supervisor`, `planner_worker`, `role_pipeline`, `hierarchical_delegation`, `blackboard`, `shared_ledger`, `mailbox_network`, `implement_review`, `critic_loop`, `council`, `debate`, `dynamic_spawning`, `coordinator_election`, `adaptive_routing`, `tree_search`, `architecture_search`, `successor_handoff`, `signed_coordination`
- `domains` (required): array of 0 to 7 items, each one of `coding`, `research`, `documents`, `reasoning`, `evaluation`, `operations`, `security`. Every task domain, in vocabulary order; each page is `/domains/{domain}.md`. The typed decision rows (`choosing`) and the general findings (`published_findings`) are on `pattern_index`.
- `pattern_index` (required): resource path, pattern `^\/[A-Za-z0-9._~/-]{0,255}$`, at most 256 characters
- `domain_index` (required): resource path, pattern `^\/[A-Za-z0-9._~/-]{0,255}$`, at most 256 characters
- `research_index` (required): resource path, pattern `^\/[A-Za-z0-9._~/-]{0,255}$`, at most 256 characters
- `starter_index` (required): resource path, pattern `^\/[A-Za-z0-9._~/-]{0,255}$`, at most 256 characters