You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules.md
+49-2Lines changed: 49 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Modules
2
2
3
-
Modules are the unit of value in StackFoundry.
3
+
Modules are the unit of value in StackFoundry. Recipes are the workflow layer that explains how modules fit together.
4
4
5
5
The first installable production modules were:
6
6
7
7
-`drizzle-postgres`
8
8
-`api-keys`
9
9
-`stripe-billing`
10
10
11
-
The registry now includes core modules, provider adapter examples, and registry-compatible public blocks. Each module should be installable into an existing app as editable source code. Presets are only bundles of modules.
11
+
The registry now includes ready source modules, stub roadmap modules, provider adapter examples, recipes, and registry-compatible public blocks. Each ready module should be installable into an existing app as editable source code. Presets are bundles of modules; recipes are opinionated architecture paths.
12
12
13
13
Use [Recipes](./recipes.md) and [Install order](./install-order.md) when you want a complete workflow instead of individual blocks.
14
14
@@ -38,6 +38,19 @@ See [Readiness](./readiness.md) for the meaning of `ready`, `stub`, `planned`, `
38
38
-`quality-tooling`
39
39
-`playwright-e2e`
40
40
41
+
### Interface Grammar
42
+
43
+
-`metric-card-grid`
44
+
-`kpi-trend-card`
45
+
-`activity-feed`
46
+
-`timeline`
47
+
-`resource-header`
48
+
-`filter-bar`
49
+
-`saved-views`
50
+
-`bulk-actions-bar`
51
+
-`status-badge-system`
52
+
-`danger-zone-card`
53
+
41
54
### Data
42
55
43
56
-`drizzle-postgres`
@@ -83,6 +96,10 @@ See [Readiness](./readiness.md) for the meaning of `ready`, `stub`, `planned`, `
83
96
-`webhook-inbox`
84
97
-`webhook-delivery`
85
98
-`developer-portal`
99
+
-`api-playground`
100
+
-`request-log-explorer`
101
+
-`usage-event-explorer`
102
+
-`webhook-delivery-detail`
86
103
87
104
### Growth and Analytics
88
105
@@ -110,6 +127,10 @@ See [Readiness](./readiness.md) for the meaning of `ready`, `stub`, `planned`, `
110
127
111
128
-`background-jobs`
112
129
-`rate-limits`
130
+
-`operator-dashboard`
131
+
-`customer-360`
132
+
-`account-health`
133
+
-`customer-timeline`
113
134
-`sentry-monitoring`
114
135
-`axiom-logging`
115
136
-`audit-log`
@@ -118,6 +139,8 @@ See [Readiness](./readiness.md) for the meaning of `ready`, `stub`, `planned`, `
118
139
-`system-health`
119
140
-`incident-management`
120
141
-`data-import-export`
142
+
-`replay-center`
143
+
-`job-run-detail`
121
144
122
145
### Provider Adapter Examples
123
146
@@ -131,6 +154,30 @@ See [Readiness](./readiness.md) for the meaning of `ready`, `stub`, `planned`, `
Copy file name to clipboardExpand all lines: docs/recipes.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Recipes
2
2
3
-
Recipes are opinionated install paths through the registry. A recipe answers "what should I install together, and in what order?" Presets remain installable bundles; recipes explain the product architecture behind those bundles.
3
+
Recipes are opinionated install paths through the registry. A recipe answers "what should I install together, and in what order?" Presets remain installable bundles; recipes explain the product architecture behind those bundles and can be installed with `stackfoundry add recipe <name>`.
Recipe definitions live in `registry/recipes/*.json` and are mirrored to `public/r/recipes/*.json` for public inspection.
28
28
29
+
The most product-ready recipe path today is `api-saas-starter`, which ties together identity, API keys, usage metering, quotas, docs, webhooks, billing, and request visibility. Stub recipes intentionally include stub modules to show the direction of a complete SaaS operating system before every source payload is ready.
@@ -82,4 +84,6 @@ Generated public module and aggregate preset items are registry-compatible `regi
82
84
83
85
Files under `/r/presets/*.json` are StackFoundry preset manifests for tooling and inspection. They are not installable registry item payloads; use `/r/<preset>.json` to install a preset bundle.
84
86
87
+
Files under `/r/recipes/*.json` are StackFoundry recipe manifests for human-readable architecture, outcomes, and staged install order. Recipes can also be installed through the StackFoundry command with `stackfoundry add recipe <name>`.
88
+
85
89
The build writes canonical generated output to `public/r` and mirrors it to `apps/web/public/r`. Vercel serves `/r/*.json` directly from the Next app as static JSON; no redirect is required.
Copy file name to clipboardExpand all lines: docs/repository.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ StackFoundry is a source registry. Every directory should either own product sou
9
9
-`examples/` contains install targets and walkthroughs used to prove registry modules in realistic app shapes.
10
10
-`packages/` is reserved for extracted library packages when command behavior, registry loading, schema validation, and shared utilities outgrow `apps/cli`.
11
11
-`public/r/` contains generated registry output. Do not edit it by hand.
12
-
-`registry/` contains source modulesand presets. This is the product surface.
12
+
-`registry/` contains source modules, presets, recipes, and shared skills. This is the product surface.
13
13
-`scripts/` is reserved for standalone maintenance scripts that should not live inside the StackFoundry command.
14
14
15
15
## Applications
@@ -25,14 +25,15 @@ StackFoundry is a source registry. Every directory should either own product sou
-`registry/presets/*.json` composes modules into installable bundles.
28
+
-`registry/recipes/*.json` describes staged install order and workflow outcomes.
28
29
29
30
## Generated Output
30
31
31
32
Run `pnpm registry:build` to regenerate `public/r`.
32
33
33
34
`public/r/registry.json` is the shadcn-compatible registry index and is not an installable item. Generated module files such as `public/r/api-keys.json` are `registry:block` item JSON files. They include file contents, target paths, package dependencies, registry dependency URLs, environment variables, docs, and metadata.
34
35
35
-
Generated aggregate preset blocks live at `public/r/<preset>.json`. Raw preset manifests live under `public/r/presets/*.json` for StackFoundry tooling and are not shadcn registry item documents.
36
+
Generated aggregate preset blocks live at `public/r/<preset>.json`. Raw preset manifests live under `public/r/presets/*.json` for StackFoundry tooling and are not shadcn registry item documents. Recipe manifests are mirrored under `public/r/recipes/*.json` for inspection and install-order guidance.
0 commit comments