Create a tiny site
Use this guide when you want the smallest useful Site Pipeline setup: one consumer-owned site catalog, one component, and one staged output.
How-to Guides
This section contains task-oriented guides for common site-pipeline workflows.
Start with Getting Started if you first need the core workflow or help choosing a publication shape.
If you need the mental model and concrete example shapes before following a procedure, read Concepts first.
Build and inspect a first site
- Create a tiny site from one catalog and one authored page.
- Inspect staged output and routes after a successful build.
Model publication and growth
- Model versioning and redirects when public routes must remain stable across releases.
- Plan publication and materialization when staging depends on selected versions or imported inputs.
- Organize grouped components and publication policy when several components share public policy.
- Integrate provider, compatibility, and translation data for larger publication ecosystems.
- Scale Site Pipeline operations when source, route, or deployment inventories need explicit operational boundaries.
Renderer integration guides
Use these guides when you already understand the staged output and now want to wire it into a concrete renderer workflow:
- integrate with Hugo — documented direct mounts
- integrate with Roq — documented consumer-side adapter
- Jekyll integration — planned-guide status page, not a turnkey recipe
- MkDocs integration — planned-guide status page, not a turnkey recipe
Deployment adapter guides
- Create HTTP server configuration from staged metadata while keeping target-specific syntax downstream of the pipeline contract.
Authoring and editor guides
Use these guides when you want faster feedback while editing catalogs and component metadata or when you need the generated file-contract schemas:
Inspect staged output and routes
Use this guide after a successful build when you want to understand what the pipeline actually staged and which public routes it resolved.
Model versioning and redirects
Use this guide when one product starts needing latest-release, development, archive, or release-specific routes without changing public permalinks by hand.
Plan publication and materialization
Use this guide when the site has enough versions, refs, or imported inputs that you need an explicit planning step before staging starts.
Organize grouped components and publication policy
Use this guide when one docs estate starts behaving like an ecosystem with many components, artifacts, or publication surfaces that should share defaults.
Integrate provider, compatibility, and translation data
Use this guide when authored publication policy is no longer enough by itself and the site needs provider-derived lifecycle data, compatibility metadata, or translation linkage.
Scale Site Pipeline operations
Use this guide when the site has enough sources, redirects, lifecycle data, or deployment targets that operational boundaries become part of the design.
Use JSON Schema for Site Pipeline file contracts
Use local Site Pipeline schema exports for completion, hover help, and early validation, and understand their intended canonical URLs.
How to create HTTP server config from staged metadata
Generate exact Apache httpd redirects from staged metadata, or choose an explicit fallback for static-only hosts such as GitHub Pages.
How to integrate Site Pipeline with Hugo
Use this guide when you want a Hugo site to render Site Pipeline staged content, staged JSON metadata, and component-aware links without hard-coding public routes.
Jekyll integration status
Current compatibility status and verification requirements for a future Site Pipeline to Jekyll integration guide.
MkDocs integration status
Current compatibility status and verification requirements for a future Site Pipeline to MkDocs integration guide.
How to integrate Site Pipeline with Roq
Adapt Site Pipeline staged content, data, and assets for a Roq renderer.