Skip to content

Commit 2170a2e

Browse files
jumskijumski
committed
docs: Split configuration docs (#255)
1 parent 8a2eb70 commit 2170a2e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+879
-548
lines changed

‎pkgs/core/assets/schema.mermaid‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
erDiagram
2+
flows ||--o{ steps : "has"
3+
flows ||--o{ runs : "instantiates"
4+
5+
steps ||--o{ deps : "depends_on"
6+
steps ||--o{ step_states : "state_of"
7+
8+
runs ||--o{ step_states : "contains"
9+
10+
step_states ||--o{ step_tasks : "spawns"
11+
12+
flows {
13+
text flow_slug PK
14+
int opt_max_attempts
15+
int opt_base_delay
16+
int opt_timeout
17+
}
18+
19+
steps {
20+
text flow_slug PK,FK
21+
text step_slug PK
22+
text step_type
23+
int step_index
24+
int deps_count
25+
int opt_max_attempts
26+
int opt_base_delay
27+
int opt_timeout
28+
int opt_start_delay
29+
}
30+
31+
deps {
32+
text flow_slug PK,FK
33+
text dep_slug PK,FK
34+
text step_slug PK,FK
35+
}
36+
37+
runs {
38+
uuid run_id PK
39+
text flow_slug FK
40+
text status
41+
jsonb input
42+
jsonb output
43+
int remaining_steps
44+
}
45+
46+
step_states {
47+
text flow_slug FK
48+
uuid run_id PK,FK
49+
text step_slug PK,FK
50+
text status
51+
int remaining_tasks
52+
int initial_tasks
53+
int remaining_deps
54+
}
55+
56+
step_tasks {
57+
text flow_slug FK
58+
uuid run_id PK,FK
59+
text step_slug PK,FK
60+
int task_index PK
61+
bigint message_id
62+
text status
63+
int attempts_count
64+
jsonb output
65+
}

‎pkgs/core/assets/schema.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎pkgs/website/astro.config.mjs‎

Lines changed: 105 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ export default defineConfig({
6363
'/getting-started/create-first-flow/': '/get-started/flows/create-flow/',
6464
'/getting-started/compile-to-sql/': '/get-started/flows/compile-flow/',
6565
'/getting-started/run-flow/': '/get-started/flows/run-flow/',
66-
'/getting-started/update-pgflow/': '/deploy/maintain/update-pgflow/',
67-
'/getting-started/configuration/': '/reference/configuration/configuration/',
66+
'/getting-started/update-pgflow/': '/deploy/update-pgflow/',
67+
'/getting-started/configuration/': '/reference/configuration/',
6868

6969
// Edge Worker reorganization
7070
'/edge-worker/getting-started/create-first-worker/':
@@ -77,55 +77,55 @@ export default defineConfig({
7777
'/edge-worker/how-to/': '/get-started/faq/',
7878
'/edge-worker/how-to/deploy-to-supabasecom/':
7979
'/deploy/supabase/deploy-first-flow/',
80-
'/edge-worker/how-to/prepare-db-string/': '/deploy/maintain/connection-string/',
80+
'/edge-worker/how-to/prepare-db-string/': '/deploy/connection-string/',
8181

8282
// FAQ move
8383
'/faq/': '/get-started/faq/',
8484

8585
// How-to → Develop/Operate reorganization
8686
'/how-to/': '/build/',
87-
'/how-to/batch-process-with-map/': '/build/authoring/process-arrays-in-parallel/',
88-
'/how-to/create-reusable-tasks/': '/build/authoring/create-reusable-tasks/',
89-
'/how-to/monitor-flow-execution/': '/deploy/observe/monitor-execution/',
90-
'/how-to/naming-steps/': '/concepts/flows/naming-steps/',
91-
'/how-to/organize-flows-code/': '/build/authoring/organize-flow-code/',
87+
'/how-to/batch-process-with-map/': '/build/process-arrays-in-parallel/',
88+
'/how-to/create-reusable-tasks/': '/build/create-reusable-tasks/',
89+
'/how-to/monitor-flow-execution/': '/deploy/monitor-execution/',
90+
'/how-to/naming-steps/': '/concepts/naming-steps/',
91+
'/how-to/organize-flows-code/': '/build/organize-flow-code/',
9292
'/how-to/version-flows/': '/build/version-flows/',
9393
'/how-to/version-your-flows/': '/build/version-flows/',
9494
'/develop/manage/version-flows/': '/build/version-flows/',
95-
'/how-to/update-flow-options/': '/deploy/maintain/tune-flow-config/',
96-
'/develop/config-tuning/update-flow-options/': '/deploy/maintain/tune-flow-config/',
97-
'/develop/manage/update-flow-options/': '/deploy/maintain/tune-flow-config/',
95+
'/how-to/update-flow-options/': '/deploy/tune-flow-config/',
96+
'/develop/config-tuning/update-flow-options/': '/deploy/tune-flow-config/',
97+
'/develop/manage/update-flow-options/': '/deploy/tune-flow-config/',
9898
'/how-to/delete-flow-and-data/': '/build/delete-flows/',
9999
'/develop/manage/delete-flows/': '/build/delete-flows/',
100-
'/how-to/manually-compile-flow/': '/reference/apis/compile-api/',
100+
'/how-to/manually-compile-flow/': '/reference/compile-api/',
101101
'/how-to/deploy-to-supabasecom/': '/deploy/supabase/deploy-first-flow/',
102102
'/how-to/keep-workers-up/': '/deploy/supabase/keep-workers-running/',
103103
'/operate/deploy/deploy-to-supabase/': '/deploy/supabase/update-deployed-flows/',
104-
'/how-to/prepare-db-string/': '/deploy/maintain/connection-string/',
105-
'/how-to/prune-old-records/': '/deploy/maintain/prune-records/',
106-
'/how-to/manual-installation/': '/reference/apis/manual-installation/',
104+
'/how-to/prepare-db-string/': '/deploy/connection-string/',
105+
'/how-to/prune-old-records/': '/deploy/prune-records/',
106+
'/how-to/manual-installation/': '/reference/manual-installation/',
107107

108108
// Develop → Build, Operate → Deploy rename
109109
'/develop/': '/build/',
110-
'/develop/authoring/create-reusable-tasks/': '/build/authoring/create-reusable-tasks/',
111-
'/develop/authoring/organize-flow-code/': '/build/authoring/organize-flow-code/',
112-
'/develop/authoring/process-arrays-in-parallel/': '/build/authoring/process-arrays-in-parallel/',
110+
'/develop/authoring/create-reusable-tasks/': '/build/create-reusable-tasks/',
111+
'/develop/authoring/organize-flow-code/': '/build/organize-flow-code/',
112+
'/develop/authoring/process-arrays-in-parallel/': '/build/process-arrays-in-parallel/',
113113
'/develop/version-flows/': '/build/version-flows/',
114114
'/develop/delete-flows/': '/build/delete-flows/',
115115
'/operate/': '/deploy/',
116116
'/operate/deploy/deploy-first-flow/': '/deploy/supabase/deploy-first-flow/',
117117
'/operate/deploy/keep-workers-running/': '/deploy/supabase/keep-workers-running/',
118118
'/operate/deploy/update-deployed-flows/': '/deploy/supabase/update-deployed-flows/',
119-
'/operate/observe/monitor-execution/': '/deploy/observe/monitor-execution/',
120-
'/operate/observe/monitor-workers-health/': '/deploy/observe/monitor-workers-health/',
121-
'/operate/maintain/connection-string/': '/deploy/maintain/connection-string/',
122-
'/operate/maintain/prune-records/': '/deploy/maintain/prune-records/',
123-
'/operate/maintain/tune-flow-config/': '/deploy/maintain/tune-flow-config/',
124-
'/operate/maintain/update-pgflow/': '/deploy/maintain/update-pgflow/',
119+
'/operate/observe/monitor-execution/': '/deploy/monitor-execution/',
120+
'/operate/observe/monitor-workers-health/': '/deploy/monitor-workers-health/',
121+
'/operate/maintain/connection-string/': '/deploy/connection-string/',
122+
'/operate/maintain/prune-records/': '/deploy/prune-records/',
123+
'/operate/maintain/tune-flow-config/': '/deploy/tune-flow-config/',
124+
'/operate/maintain/update-pgflow/': '/deploy/update-pgflow/',
125125

126126
// Explanations to Concepts/Comparisons
127127
'/explanations/': '/concepts/overview/',
128-
'/explanations/flow-dsl/': '/concepts/flows/understanding-flows/',
128+
'/explanations/flow-dsl/': '/concepts/understanding-flows/',
129129
'/explanations/comparison-to-dbos/': '/comparisons/dbos/',
130130
'/explanations/comparison-to-inngest/': '/comparisons/inngest/',
131131
'/explanations/comparison-to-trigger-dev/': '/comparisons/trigger/',
@@ -139,14 +139,39 @@ export default defineConfig({
139139
// Edge Worker → Reference/Queue Worker
140140
'/edge-worker/getting-started/configuration/': '/reference/queue-worker/configuration/',
141141
'/edge-worker/how-it-works/': '/reference/queue-worker/how-it-works/',
142-
'/edge-worker/getting-started/observability/': '/deploy/observe/monitor-workers-health/',
142+
'/edge-worker/getting-started/observability/': '/deploy/monitor-workers-health/',
143143

144144
// Concepts reorganization
145145
'/concepts/': '/concepts/overview/',
146-
'/concepts/flow-dsl/': '/concepts/flows/understanding-flows/',
147-
'/concepts/map-steps/': '/concepts/flows/map-steps/',
148-
'/concepts/context/': '/concepts/flows/context/',
149-
'/concepts/how-pgflow-works/': '/concepts/architecture/how-pgflow-works/',
146+
'/concepts/flow-dsl/': '/concepts/understanding-flows/',
147+
'/concepts/array-and-map-steps/': '/concepts/map-steps/',
148+
'/concepts/context/': '/concepts/context-object/',
149+
150+
// URL Flattening - Build section
151+
'/build/authoring/organize-flow-code/': '/build/organize-flow-code/',
152+
'/build/authoring/configuration-patterns/': '/build/configuration-patterns/',
153+
'/build/authoring/create-reusable-tasks/': '/build/create-reusable-tasks/',
154+
'/build/authoring/process-arrays-in-parallel/': '/build/process-arrays-in-parallel/',
155+
156+
// URL Flattening - Deploy section
157+
'/deploy/observe/monitor-execution/': '/deploy/monitor-execution/',
158+
'/deploy/observe/monitor-workers-health/': '/deploy/monitor-workers-health/',
159+
'/deploy/maintain/connection-string/': '/deploy/connection-string/',
160+
'/deploy/maintain/prune-records/': '/deploy/prune-records/',
161+
'/deploy/maintain/tune-flow-config/': '/deploy/tune-flow-config/',
162+
'/deploy/maintain/update-pgflow/': '/deploy/update-pgflow/',
163+
164+
// URL Flattening - Concepts section
165+
'/concepts/architecture/how-pgflow-works/': '/concepts/how-pgflow-works/',
166+
'/concepts/flows/understanding-flows/': '/concepts/understanding-flows/',
167+
'/concepts/flows/map-steps/': '/concepts/map-steps/',
168+
'/concepts/flows/context/': '/concepts/context-object/',
169+
'/concepts/flows/naming-steps/': '/concepts/naming-steps/',
170+
171+
// URL Flattening - Reference section
172+
'/reference/apis/context/': '/reference/context/',
173+
'/reference/apis/compile-api/': '/reference/compile-api/',
174+
'/reference/apis/manual-installation/': '/reference/manual-installation/',
150175
},
151176

152177
integrations: [
@@ -251,8 +276,8 @@ export default defineConfig({
251276
'index',
252277
'**/index',
253278
'tutorials/ai-web-scraper/*',
254-
'concepts/flows/naming-steps',
255-
'deploy/maintain/tune-flow-config',
279+
'concepts/naming-steps',
280+
'deploy/tune-flow-config',
256281
'get-started/faq',
257282
'news/**',
258283
'hire/**',
@@ -262,22 +287,23 @@ export default defineConfig({
262287
'get-started/flows/create-flow',
263288
'get-started/flows/compile-flow',
264289
'get-started/flows/run-flow',
265-
'concepts/architecture/how-pgflow-works',
266-
'concepts/flows/understanding-flows',
267-
'build/authoring/create-reusable-tasks',
268-
'deploy/observe/monitor-execution',
290+
'concepts/how-pgflow-works',
291+
'concepts/data-model',
292+
'concepts/understanding-flows',
293+
'build/create-reusable-tasks',
294+
'deploy/monitor-execution',
269295
'build/version-flows',
270-
'build/authoring/organize-flow-code',
296+
'build/organize-flow-code',
271297
],
272298
demote: [
273299
'edge-worker/*',
274300
'reference/queue-worker/*',
275301
'comparisons/*',
276302
'deploy/supabase/deploy-first-flow',
277303
'deploy/supabase/update-deployed-flows',
278-
'reference/apis/manual-installation',
279-
'deploy/maintain/connection-string',
280-
'deploy/maintain/prune-records',
304+
'reference/manual-installation',
305+
'deploy/connection-string',
306+
'deploy/prune-records',
281307
'build/delete-flows',
282308
'project-status',
283309
],
@@ -312,11 +338,21 @@ export default defineConfig({
312338
items: [
313339
{ label: 'Overview', link: '/build/' },
314340
{
315-
label: 'Authoring',
316-
autogenerate: { directory: 'build/authoring/' },
341+
label: 'Writing Flows',
342+
items: [
343+
{ label: 'Organize flow code', link: '/build/organize-flow-code/' },
344+
{ label: 'Configuration patterns', link: '/build/configuration-patterns/' },
345+
{ label: 'Create reusable tasks', link: '/build/create-reusable-tasks/' },
346+
{ label: 'Process arrays in parallel', link: '/build/process-arrays-in-parallel/' },
347+
],
348+
},
349+
{
350+
label: 'Flow Management',
351+
items: [
352+
{ label: 'Version flows', link: '/build/version-flows/' },
353+
{ label: 'Delete flows', link: '/build/delete-flows/' },
354+
],
317355
},
318-
{ label: 'Version flows', link: '/build/version-flows/' },
319-
{ label: 'Delete flows', link: '/build/delete-flows/' },
320356
],
321357
},
322358
{
@@ -332,11 +368,19 @@ export default defineConfig({
332368
},
333369
{
334370
label: 'Observe',
335-
autogenerate: { directory: 'deploy/observe/' },
371+
items: [
372+
{ label: 'Monitor flow execution', link: '/deploy/monitor-execution/' },
373+
{ label: 'Monitor workers health', link: '/deploy/monitor-workers-health/' },
374+
],
336375
},
337376
{
338377
label: 'Maintain',
339-
autogenerate: { directory: 'deploy/maintain/' },
378+
items: [
379+
{ label: 'Connection string encoding', link: '/deploy/connection-string/' },
380+
{ label: 'Prune records', link: '/deploy/prune-records/' },
381+
{ label: 'Tune deployed flows', link: '/deploy/tune-flow-config/' },
382+
{ label: 'Update pgflow', link: '/deploy/update-pgflow/' },
383+
],
340384
},
341385
],
342386
},
@@ -349,11 +393,19 @@ export default defineConfig({
349393
{ label: 'Overview', link: '/concepts/overview/' },
350394
{
351395
label: 'Architecture',
352-
autogenerate: { directory: 'concepts/architecture/' },
396+
items: [
397+
{ label: 'How pgflow works', link: '/concepts/how-pgflow-works/' },
398+
{ label: 'Data model', link: '/concepts/data-model/' },
399+
],
353400
},
354401
{
355402
label: 'Defining Flows',
356-
autogenerate: { directory: 'concepts/flows/' },
403+
items: [
404+
{ label: 'Understanding flows', link: '/concepts/understanding-flows/' },
405+
{ label: 'Map steps', link: '/concepts/map-steps/' },
406+
{ label: 'Context object', link: '/concepts/context-object/' },
407+
{ label: 'Naming steps', link: '/concepts/naming-steps/' },
408+
],
357409
},
358410
],
359411
},
@@ -370,7 +422,11 @@ export default defineConfig({
370422
},
371423
{
372424
label: 'APIs',
373-
autogenerate: { directory: 'reference/apis/' },
425+
items: [
426+
{ label: 'Context API', link: '/reference/context/' },
427+
{ label: 'Compile API', link: '/reference/compile-api/' },
428+
{ label: 'Manual installation', link: '/reference/manual-installation/' },
429+
],
374430
},
375431
{
376432
label: 'Queue Worker',

‎pkgs/website/public/diagrams/schema.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎pkgs/website/src/assets/hero_content_pipeline.mermaid‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
graph TD
2+
fetchArticle[fetchArticle] --> summarize[summarize]
3+
fetchArticle --> extractKeywords[extractKeywords]
4+
fetchArticle --> generateImage[generateImage]
5+
summarize --> publish[publish]
6+
extractKeywords --> publish
7+
generateImage --> publish

0 commit comments

Comments
 (0)