-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
good first issueGood for newcomersGood for newcomers
Description
Summary
New users often want to see specific patterns beyond the full examples. A short cookbook/recipes document showing common patterns would help with onboarding.
What to do
Create docs/COOKBOOK.md with short, copy-paste-ready snippets for:
- Singleton entity — how to define a config entity that only has one instance (see CRM pipeline example)
- Entity relationships — how to link entities via the
relationshipsfield (e.g., task → project) - Structured search — common filter patterns (
$gte,$in,$contains) - Soft delete + restore — delete an entity and bring it back
- Seed data format — how to structure seed JSON files (single entity vs. array)
Each recipe should be 10-20 lines with a code snippet and one sentence of explanation.
Acceptance criteria
-
docs/COOKBOOK.mdexists with 5+ recipes - Each recipe has a working code example
- Linked from the main README (in the Specs table or a new section)
Estimated time: ~2 hours
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomers