Skip to content

Commit d4b460c

Browse files
committed
add table of contents
1 parent 977f671 commit d4b460c

File tree

1 file changed

+50
-11
lines changed

1 file changed

+50
-11
lines changed

README.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Learn more about Cadence at:
2525
git clone https://github.com/uber-common/cadence-samples.git && cd cadence-samples
2626
```
2727

28-
2. Start Cadence Server*
28+
2. **Start Cadence Server**
2929
```bash
3030
curl -LO https://raw.githubusercontent.com/cadence-workflow/cadence/refs/heads/master/docker/docker-compose.yml && docker-compose up --wait
3131
```
@@ -39,6 +39,44 @@ make
3939

4040
## 📚 Sample Categories
4141

42+
### Table of Contents
43+
- [🎯 Basic Examples](#-basic-examples)
44+
- [Hello World](#hello-world-cmdsamplesrecipeshelloworld)
45+
- [Greetings](#greetings-cmdsamplesrecipesgreetings)
46+
- [Cron](#cron-cmdsamplescron)
47+
- [Timer](#timer-cmdsamplesrecipestimer)
48+
- [Delay Start](#delay-start-cmdsamplesrecipesdelaystart)
49+
- [Branch](#branch-cmdsamplesrecipesbranch)
50+
- [Split-Merge](#split-merge-cmdsamplesrecipessplitmerge)
51+
- [Pick First](#pick-first-cmdsamplesrecipespickfirst)
52+
53+
- [🔧 Advanced Examples](#-advanced-examples)
54+
- [Choice](#choice-cmdsamplesrecipeschoice)
55+
- [Retry Activity](#retry-activity-cmdsamplesrecipesretryactivity)
56+
- [Cancel Activity](#cancel-activity-cmdsamplesrecipescancelactivity)
57+
- [Mutex](#mutex-cmdsamplesrecipesmutex)
58+
- [Query](#query-cmdsamplesrecipesquery)
59+
- [Consistent Query](#consistent-query-cmdsamplesrecipesconsistentquery)
60+
- [Child Workflow](#child-workflow-cmdsamplesrecipeschildworkflow)
61+
- [Dynamic](#dynamic-cmdsamplesrecipesdynamic)
62+
- [Local Activity](#local-activity-cmdsamplesrecipeslocalactivity)
63+
- [Versioning](#versioning-cmdsamplesrecipesversioning)
64+
- [Search Attributes](#search-attributes-cmdsamplesrecipessearchattributes)
65+
- [Context Propagation](#context-propagation-cmdsamplesrecipesctxpropagation)
66+
- [Tracing](#tracing-cmdsamplesrecipestracing)
67+
- [Side Effect](#side-effect-cmdsamplesrecipessideeffect)
68+
- [Batch](#batch-cmdsamplesbatch)
69+
- [Recovery](#recovery-cmdsamplesrecovery)
70+
71+
- [🏢 Business Application Examples](#-business-application-examples)
72+
- [Expense](#expense-cmdsamplesexpense)
73+
- [File Processing](#file-processing-cmdsamplesfileprocessing)
74+
- [DSL](#dsl-cmdsamplesdsl)
75+
- [Page Flow](#page-flow-cmdsamplespageflow)
76+
- [PSO (Particle Swarm Optimization)](#pso-particle-swarm-optimization-cmdsamplespso)
77+
78+
---
79+
4280
### 🎯 **Basic Examples**
4381

4482
#### [Hello World](cmd/samples/recipes/helloworld/)
@@ -184,7 +222,7 @@ Start Workflow:
184222
./bin/pickfirst -m trigger
185223
```
186224

187-
### 🔍 **Advanced Examples**
225+
### 🔧 **Advanced Examples**
188226

189227
#### [Choice](cmd/samples/recipes/choice/)
190228
* **Shows**: Conditional execution and decision-based activity routing.
@@ -406,15 +444,6 @@ Start Workflow:
406444
./bin/batch -m trigger
407445
```
408446

409-
#### [PSO (Particle Swarm Optimization)](cmd/samples/pso/)
410-
* **Shows**: Complex mathematical workflows and long-running optimization workflows.
411-
* **What it does**: Implements particle swarm optimization with child workflows and ContinueAsNew.
412-
* **Real-world use case**: Mathematical optimization, machine learning training, complex calculations.
413-
* **Key concepts**: Long-running workflows, ContinueAsNew, child workflows, custom data converters.
414-
415-
##### How to run
416-
* Check **[Detailed Guide](cmd/samples/pso/README.md)** to run the sample
417-
418447
#### [Recovery](cmd/samples/recovery/)
419448
* **Shows**: Workflow recovery and failure handling.
420449
* **What it does**: Shows how to restart failed workflows and replay signals.
@@ -470,6 +499,16 @@ Start Workflow:
470499
##### How to run
471500
* Check **[Detailed Guide](cmd/samples/pageflow/README.md)** to run the sample
472501

502+
503+
#### [PSO (Particle Swarm Optimization)](cmd/samples/pso/)
504+
* **Shows**: Complex mathematical workflows and long-running optimization workflows.
505+
* **What it does**: Implements particle swarm optimization with child workflows and ContinueAsNew.
506+
* **Real-world use case**: Mathematical optimization, machine learning training, complex calculations.
507+
* **Key concepts**: Long-running workflows, ContinueAsNew, child workflows, custom data converters.
508+
509+
##### How to run
510+
* Check **[Detailed Guide](cmd/samples/pso/README.md)** to run the sample
511+
473512
## 🛠 **Development & Testing**
474513

475514
### Building Samples

0 commit comments

Comments
 (0)