Skip to content

Commit 5eb7ef5

Browse files
committed
chore: update documentation and navigation to include starting flows from TypeScript and pgflow client (#257)
## Summary Simplified and standardized titles across the "Starting Flows" documentation section for better scannability and consistency. ## Changes ### 1\. Simplified Overview Page (`build/starting-flows/index.mdx`) **Title Changes:** - Page title: "How to Start Flows" → "Choose your approach" - Section header: "Detailed Guides on starting flows" → "Detailed Guides" **Content Improvements:** - Removed redundant qualifiers ("depending on your needs", "full", "simple") - Removed 4 repetitive "Quick Example:" labels (structure already implies these are examples) - Result: 8% word reduction (218 → ~200 words) while maintaining all essential information **Card Title Simplification:** - "From TypeScript Client" → "TypeScript Client" - "With Supabase RPC" → "Supabase RPC" - "With pg_cron" → "pg_cron" - "From Database Triggers" → "Database Triggers" ### 2\. Updated Build Index (`build/index.mdx`) Updated all "Starting Flows" link card titles to match the simplified naming: - "How to Start Flows" → "Choose your approach" - "Start Flows from TypeScript Client" → "TypeScript Client" - "Start Flows with Supabase RPC" → "Supabase RPC" - "Schedule Flows with pg_cron" → "pg_cron" - "Trigger Flows on Data Changes" → "Database Triggers" ### 3\. Updated Detail Page Titles Updated frontmatter titles for autogenerated sidebar consistency: - `typescript-client.mdx`: "Start Flows from TypeScript Client" → "TypeScript Client" - `supabase-rpc.mdx`: "Start Flows with Supabase RPC" → "Supabase RPC" - `pg-cron.mdx`: "Schedule Flows with pg_cron" → "pg_cron" - `database-triggers.mdx`: "Trigger Flows on Data Changes" → "Database Triggers" ## Benefits 1. **Better Scannability:** Shorter titles are easier to scan in navigation and card grids 2. **Consistency:** Titles now match across overview pages, detail pages, and sidebar 3. **Cleaner Design:** Reduced visual noise makes information hierarchy clearer 4. **MVP Mindset:** Follows the principle of cutting scope and simplifying aggressively ## Testing - Verified all links remain functional - Confirmed titles display correctly in sidebar navigation - Checked that card grids maintain proper layout - Ensured descriptions still provide sufficient context
1 parent 9707538 commit 5eb7ef5

32 files changed

+1822
-296
lines changed

pkgs/client/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,5 +376,6 @@ See [BUILD_AND_RELEASE.md](./BUILD_AND_RELEASE.md#browser-via-cdn) for full CDN
376376
For more detailed documentation, visit:
377377

378378
- [pgflow Documentation](https://pgflow.dev)
379-
- [Client Library Guide](https://pgflow.dev/how-to/monitor-flow-execution)
379+
- [Start Flows from TypeScript Client](https://pgflow.dev/build/starting-flows/typescript-client/)
380+
- [Client API Reference](https://pgflow.dev/reference/pgflow-client/)
380381

pkgs/client/project.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,9 +216,7 @@
216216
},
217217
"test:types:strict": {
218218
"executor": "nx:run-commands",
219-
"cache": true,
220-
"dependsOn": ["build"],
221-
"inputs": ["default", "^production"],
219+
"dependsOn": ["^build"],
222220
"options": {
223221
"cwd": "{projectRoot}",
224222
"command": "bash ../../scripts/typecheck-ts2578.sh"

pkgs/core/project.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -285,9 +285,7 @@
285285
},
286286
"test:types:strict": {
287287
"executor": "nx:run-commands",
288-
"cache": true,
289288
"dependsOn": ["^build"],
290-
"inputs": ["default", "^production"],
291289
"options": {
292290
"cwd": "{projectRoot}",
293291
"command": "bash ../../scripts/typecheck-ts2578.sh"

pkgs/dsl/project.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,15 @@
3838
},
3939
"test:types:vitest": {
4040
"executor": "nx:run-commands",
41-
"cache": true,
4241
"dependsOn": ["build"],
43-
"inputs": ["default", "^production"],
4442
"options": {
4543
"cwd": "{projectRoot}",
4644
"command": "pnpm vitest --typecheck.only --run"
4745
}
4846
},
4947
"test:types:strict": {
5048
"executor": "nx:run-commands",
51-
"cache": true,
52-
"dependsOn": ["^build"],
53-
"inputs": ["default", "^production"],
49+
"dependsOn": ["build"],
5450
"options": {
5551
"cwd": "{projectRoot}",
5652
"command": "bash ../../scripts/typecheck-ts2578.sh"

pkgs/website/astro.config.mjs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,9 @@ export default defineConfig({
168168
'/concepts/flows/context/': '/concepts/context-object/',
169169
'/concepts/flows/naming-steps/': '/concepts/naming-steps/',
170170

171+
// Architecture page rename
172+
'/concepts/architecture/': '/concepts/three-layer-architecture/',
173+
171174
// URL Flattening - Reference section
172175
'/reference/apis/context/': '/reference/context/',
173176
'/reference/apis/compile-api/': '/reference/compile-api/',
@@ -346,6 +349,10 @@ export default defineConfig({
346349
{ label: 'Process arrays in parallel', link: '/build/process-arrays-in-parallel/' },
347350
],
348351
},
352+
{
353+
label: 'Starting Flows',
354+
autogenerate: { directory: 'build/starting-flows/' },
355+
},
349356
{
350357
label: 'Flow Management',
351358
items: [
@@ -395,7 +402,7 @@ export default defineConfig({
395402
label: 'Architecture',
396403
items: [
397404
{ label: 'How pgflow works', link: '/concepts/how-pgflow-works/' },
398-
{ label: 'Architecture', link: '/concepts/architecture/' },
405+
{ label: 'Three-layer architecture', link: '/concepts/three-layer-architecture/' },
399406
{ label: 'Data model', link: '/concepts/data-model/' },
400407
],
401408
},
@@ -424,6 +431,7 @@ export default defineConfig({
424431
{
425432
label: 'APIs',
426433
items: [
434+
{ label: '@pgflow/client API', link: '/reference/pgflow-client/' },
427435
{ label: 'Context API', link: '/reference/context/' },
428436
{ label: 'Compile API', link: '/reference/compile-api/' },
429437
{ label: 'Manual installation', link: '/reference/manual-installation/' },
234 KB
Loading
14.8 KB
Loading
8.62 KB
Loading

pkgs/website/src/content/docs/build/index.mdx

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to build and author pgflow workflows
55

66
import { CardGrid, LinkCard } from '@astrojs/starlight/components';
77

8-
Now that you've created your first flow, learn how to structure your code, iterate on your flows, and clean up during development.
8+
Now that you've created your first flow, learn how to structure your code, integrate workflows in applications, and manage your workflows.
99

1010
## Writing Flows
1111

@@ -32,6 +32,36 @@ Now that you've created your first flow, learn how to structure your code, itera
3232
/>
3333
</CardGrid>
3434

35+
## Starting Flows
36+
37+
<CardGrid>
38+
<LinkCard
39+
title="Choose your approach"
40+
href="/build/starting-flows/"
41+
description="Overview and comparison - choose the right approach for your use case"
42+
/>
43+
<LinkCard
44+
title="TypeScript Client"
45+
href="/build/starting-flows/typescript-client/"
46+
description="Full client library with real-time streaming and event subscriptions"
47+
/>
48+
<LinkCard
49+
title="Supabase RPC"
50+
href="/build/starting-flows/supabase-rpc/"
51+
description="Simple RPC calls for fire-and-forget workflow triggering"
52+
/>
53+
<LinkCard
54+
title="pg_cron"
55+
href="/build/starting-flows/pg-cron/"
56+
description="Run workflows on a recurring schedule with cron expressions"
57+
/>
58+
<LinkCard
59+
title="Database Triggers"
60+
href="/build/starting-flows/database-triggers/"
61+
description="Automatically start workflows when database records change"
62+
/>
63+
</CardGrid>
64+
3565
## Flow Management
3666

3767
<CardGrid>

0 commit comments

Comments
 (0)