---
title: Scaffold Reference
description: Universal scaffold documentation for Elevasis SDK projects -- recipes, patterns, architecture, and reference materials that apply to all workspaces.
---
<!-- @generated by packages/sdk/scripts/copy-reference-docs.mjs -- DO NOT EDIT -->
<!-- Regenerate: pnpm scaffold:sync -->


## Overview

This scaffold reference contains universal documentation that applies to all Elevasis SDK projects. Content is organized by package ownership:

- **recipes/** -- Cross-package pathway recipes (add a system, add a resource, gating patterns)
- **ui/** -- UI patterns, system shell architecture, composition, and customization
- **core/** -- Organization model architecture, graph layer, and semantic contracts
- **operations/** -- Workflow authoring patterns and adapter usage
- **reference/** -- Glossary, auto-generated contracts, and system registry

## Quick Navigation

### Pathway Recipes

- [Add an OM-Backed System](./recipes/add-a-feature.md) -- cohesive System, ontology scope, Resource, runtime, UI, and test workflow
- [Add a Resource](./recipes/add-a-resource.md) -- author and deploy a workflow or agent
- [Extend a Base Entity](./recipes/extend-a-base-entity.md) -- add project-specific metadata to canonical entity shapes via the TMeta slot
- [Gate by System or Admin](./recipes/gate-by-feature-or-admin.md) -- decision table for access control patterns
- [Build and Extend CRM](./recipes/extend-crm.md) -- map CRM UI pages, hooks, actions, workflow adapters, contracts, and org-model boundaries
- [Build and Extend Lead Gen](./recipes/extend-lead-gen.md) -- map lead-gen UI pages, hooks, list/member state, artifacts, workflow adapters, contracts, and org-model boundaries
- [Customize CRM Actions](./recipes/customize-crm-actions.md) -- add, hide, or replace CRM deal actions, use the shared `crmActions` provider path, and understand workflow dispatch constraints

### UI Patterns

- [UI Recipes](./ui/recipes.md) -- copy-paste recipes for pages, nav items, components, theme tokens
- [System Flags & Gating](./ui/feature-flags-and-gating.md) -- three-concept model for system access
- [Customizing Systems](./ui/customization.md) -- sidebar composition via manifest overrides
- [System Shell & Provider](./ui/feature-shell.mdx) -- SystemModule manifest contract, provider runtime
- [Composition & Extensibility](./ui/composition-extensibility.mdx) -- layout primitives, router abstraction

### Core Architecture

- [Organization Model](./core/organization-model.mdx) -- semantic contract, schema, authoring helpers
- [Organization Graph](./core/organization-graph.mdx) -- graph derivation, node/edge taxonomy, lenses

### Operations

- [Workflow Recipes](./operations/workflow-recipes.md) -- workflow anatomy, adapter patterns, trigger patterns
- [Propagation Pipeline](./operations/propagation-pipeline.md) -- three-layer sync pipeline, verification checks, integration points
- [Scaffold Maintenance](./operations/scaffold-maintenance.md) -- content placement, auto-generation, adding new scaffold docs

### Reference

- [Glossary](./reference/glossary.md) -- term definitions for Organization OS concepts
- [Contracts](./reference/contracts.md) -- auto-generated TypeScript contract shapes
- [System Interface Capabilities](./reference/system-interface-capabilities.md) -- auto-generated catalog of supported System Interface profiles and readiness requirements
- [System Registry](./reference/feature-registry.md) -- auto-generated system manifest catalog

## Source Locations

Content is co-located with its owning package and copied here during SDK build:

| Bundle Path                                   | Source Location                                           | Owner           |
| --------------------------------------------- | --------------------------------------------------------- | --------------- |
| `scaffold/recipes/`                           | `packages/sdk/docs/scaffold/recipes/`                     | SDK             |
| `scaffold/operations/`                        | `packages/sdk/docs/scaffold/operations/`                  | SDK             |
| `scaffold/operations/propagation-pipeline.md` | `packages/sdk/docs/scaffold/operations/`                  | SDK             |
| `scaffold/operations/scaffold-maintenance.md` | `packages/sdk/docs/scaffold/operations/`                  | SDK             |
| `scaffold/ui/`                                | `packages/ui/src/scaffold/`                               | UI              |
| `scaffold/core/`                              | `packages/core/src/organization-model/`                   | Core            |
| `scaffold/reference/glossary.md`              | `packages/core/src/reference/glossary.md`                 | Core            |
| `scaffold/reference/contracts.md`             | `packages/core/src/reference/_generated/contracts.md`     | Core (auto-gen) |
| `scaffold/reference/system-interface-capabilities.md` | `packages/core/src/reference/_generated/system-interface-capabilities.md` | Core (auto-gen) |
| `scaffold/reference/feature-registry.md`      | `packages/ui/src/scaffold/_generated/feature-registry.md` | UI (auto-gen)   |
