Site Pipeline

Assemble component-owned docs into a predictable site contract.

The Site Pipeline discovers component content, validates the workspace contract, and stages normalized pages, docs, assets, and metadata for a downstream site renderer.

Site Pipeline has not published a release yet. This page describes the current development branch and links to unreleased development contracts.

It gives a consumer site one place to aggregate cross-repository content without pulling renderer logic, branding, or publishing policy into every component.

Get started Read unreleased development docs Browse source

Why teams use it

one staging contract for component pages, docs, assets, and lifecycle data,
safety checks for workspace paths and protected outputs,
generated metadata for navigation, release lines, and renderer-owned preview links, and
check, plan, build, component-source-roots, and watch CLI workflows.

What you integrate

The consumer repository owns site/catalog.yaml. That catalog selects the participating source trees, component identities, content roots, and publication policy. It may also opt into a provider snapshot and top-level site pages or assets.

Participating repositories provide the page, documentation, and asset roots selected by the catalog. They may provide site/component.yaml when the catalog or shared defaults select a component metadata file, but the smallest working catalog does not require one.

The consumer repository keeps ownership of the rendered site experience:

theme integration,
shared layouts and helper shortcodes,
navigation and branding,
publishing, and
environment-specific runtime choices.

Start here

Getting started for size-band onboarding and first setup
Concepts for the mental model and staged-output boundary
How-to for task-oriented procedures
Architecture for deeper system shape and rationale
Unreleased development reference for contracts, schemas, and trust rules that have not been published as a release
Maintenance for maintainer-facing implementation guidance
Buildish community for participation, conduct, security, and license information

Source layout in this repository

This component keeps non-versioned reader and maintainer pages under site/pages/ and keeps versioned or normative reference material under docs/.

That split matches the authored-content contract exposed by site/component.yaml:

site/pages/ for top-level component pages,
docs/ for versioned or development docs content, and
optional site/assets/ for component-owned static assets.

Learn more in the source tree

Start with the docs for the current contract, configuration model, and adoption patterns. If you are integrating or modifying the pipeline, the source repository contains the implementation, tests, and extracted component content.