Commit 5eb7ef5
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 context1 parent 9707538 commit 5eb7ef5
File tree
32 files changed
+1822
-296
lines changed- pkgs
- client
- core
- dsl
- website
- src
- assets
- cover-images
- news-images/pgflow-0-7-0-public-beta-map-steps-and-documentation-redesign
- content/docs
- build
- starting-flows
- concepts
- overview
- deploy
- get-started
- flows
- news
- reference
- styles
32 files changed
+1822
-296
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
376 | 376 | | |
377 | 377 | | |
378 | 378 | | |
379 | | - | |
| 379 | + | |
| 380 | + | |
380 | 381 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
216 | 216 | | |
217 | 217 | | |
218 | 218 | | |
219 | | - | |
220 | | - | |
221 | | - | |
| 219 | + | |
222 | 220 | | |
223 | 221 | | |
224 | 222 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
285 | 285 | | |
286 | 286 | | |
287 | 287 | | |
288 | | - | |
289 | 288 | | |
290 | | - | |
291 | 289 | | |
292 | 290 | | |
293 | 291 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
41 | | - | |
42 | 41 | | |
43 | | - | |
44 | 42 | | |
45 | 43 | | |
46 | 44 | | |
47 | 45 | | |
48 | 46 | | |
49 | 47 | | |
50 | 48 | | |
51 | | - | |
52 | | - | |
53 | | - | |
| 49 | + | |
54 | 50 | | |
55 | 51 | | |
56 | 52 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
168 | 168 | | |
169 | 169 | | |
170 | 170 | | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
171 | 174 | | |
172 | 175 | | |
173 | 176 | | |
| |||
346 | 349 | | |
347 | 350 | | |
348 | 351 | | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
349 | 356 | | |
350 | 357 | | |
351 | 358 | | |
| |||
395 | 402 | | |
396 | 403 | | |
397 | 404 | | |
398 | | - | |
| 405 | + | |
399 | 406 | | |
400 | 407 | | |
401 | 408 | | |
| |||
424 | 431 | | |
425 | 432 | | |
426 | 433 | | |
| 434 | + | |
427 | 435 | | |
428 | 436 | | |
429 | 437 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
35 | 65 | | |
36 | 66 | | |
37 | 67 | | |
| |||
0 commit comments