FSH Guides¶
Cross-cutting guides for the FSH stack. This site is a hub: it orients you and points to the right reference docs. Each library and tool documents its own API in its own site — start here, then follow the links out.
All the per-repo sites also hang off the index at docs.efesaitch.com.
Reference docs, and when to reach for each¶
Site |
When to reach for it |
Link |
|---|---|---|
Codegen |
The code-generation engine (fka foundry). Read this to understand how backends, frontends, and OPA policy get generated from your resource definitions. |
|
Codegen Database |
The Postgres framework (fka pgcraft) behind generated apps: migrations, column types, schema conventions. |
|
Python Library |
The runtime library (fka ingot) that generated FastAPI backends import: auth, actions, filters, pagination, queue, telemetry. |
|
Components Library |
The React UI components (fka glaze) the generated frontends render with. |
|
GitHub Actions |
The org’s reusable workflows and composite actions: CI, releases, deploys, docs. |
Where things fit together¶
The generated apps lean on every site above at once:
Codegen + Codegen Database generate the app (backend, frontend, OPA, schema) from your resource definitions.
The generated backend imports the Python Library at runtime; the generated frontend renders with the Components Library.
GitHub Actions builds, tests, releases, and deploys all of it (this docs site included).