Skip to content

Guides

Guides answer “I want to do X — show me.” They assume you have read the relevant Concepts page and now want a concrete recipe.

A guide is short and runnable. It does not re-explain the underlying model — it links to Concepts when context is needed and to Reference when an exhaustive parameter list is needed.

GuideWhen you reach for it
Add an entity to a featureA second entity in a feature you already have.
Write a custom write handlerDefault CRUD doesn’t fit; you need business rules on save.
Restrict a field to specific rolesA column visible to admins only, writable by everyone.
Expose a public, anonymous-readable endpointPublic status pages, marketing landings, hosted reports.
Call the API headlessly with a Personal Access TokenCI, a script, or a customer integration needs a long-lived, scoped bearer token.
Add TOTP-based 2FA to loginUsers should enroll an authenticator app as a second login factor.
React to another feature’s eventsFeature A reacts when feature B writes — without imports.
Seed default data for new tenantsNew tenant signs up; populate their workspace.
Apply one-shot data migrations via the event storeA role changed name, an admin needs an extra membership — run it once, tracked, ES-conform.
Build a read model across multiple aggregatesAggregate events from several entities into one view.
Dialog and Lightbox overlaysConfirm modals vs full-size image preview; Apex screenshot zoom.
Make your apex/content pages SEO/AEO/GEO discoverableYou mounted seo but don’t know what to actually configure to show up in search/answer engines.
  • Recipes — runnable end-to-end examples (fuller code than a guide, less explanation).
  • Concepts — the mental model that the guides assume you’ve read.