Skip to content

Commit 7971e28

Browse files
authored
Merge branch 'main' into dabh/sentence-case-tech-resources
2 parents 5d212e3 + 8c5e459 commit 7971e28

18 files changed

Lines changed: 486 additions & 166 deletions

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Guidance for AI coding agents working in the [Temporal documentation](https://gi
88
|-------|------|
99
| Where content belongs | [INFORMATION-ARCHITECTURE.md](./INFORMATION-ARCHITECTURE.md) |
1010
| React components in MDX | [COMPONENTS.md](./COMPONENTS.md) |
11+
| Mermaid diagrams | [MERMAID.md](./readme/MERMAID.md) |
1112
| LLM Markdown pipeline | [MARKDOWN_PIPELINE.md](./MARKDOWN_PIPELINE.md) |
1213
| Component → Markdown mapping | [COMPONENT_REGISTRY.md](./COMPONENT_REGISTRY.md) |
1314

docs/cloud/connectivity/aws-connectivity.mdx

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,6 @@ keywords:
2323

2424
import { CaptionedImage, JsonTable } from '@site/src/components';
2525

26-
<style>{`
27-
.docusaurus-mermaid-container .edgeLabel,
28-
.docusaurus-mermaid-container .edgeLabel p,
29-
.docusaurus-mermaid-container .edgeLabel rect,
30-
.docusaurus-mermaid-container .edgeLabel .labelBkg {
31-
background-color: var(--ifm-background-color) !important;
32-
fill: var(--ifm-background-color) !important;
33-
}
34-
`}</style>
35-
3626
[AWS PrivateLink](https://aws.amazon.com/privatelink/) allows you to open a path to Temporal without opening a public egress.
3727
It establishes a private connection between your Amazon Virtual Private Cloud (VPC) and Temporal Cloud.
3828
This one-way connection means Temporal cannot establish a connection back to your service.
@@ -237,10 +227,10 @@ title: Direct VPCE targeting (single region)
237227
---
238228
%%{init: {'themeVariables':{'fontFamily':'Inter, ui-sans-serif, system-ui, sans-serif'},'flowchart':{'nodeSpacing':18,'rankSpacing':45,'curve':'basis','subGraphTitleMargin':{'top':6,'bottom':12}}}}%%
239229
flowchart LR
240-
classDef worker fill:#7C3AED22,stroke:#7C3AED,stroke-width:1px;
241-
classDef ns fill:#59FDA024,stroke:#59FDA0,stroke-width:1px;
242-
classDef endpoint fill:transparent,stroke:#c2c8d2,stroke-width:1px;
243-
classDef region fill:transparent,stroke:#9aa4b2,stroke-width:1.5px;
230+
classDef worker stroke-width:1px;
231+
classDef ns stroke-width:1px;
232+
classDef endpoint stroke-width:1px;
233+
classDef region stroke-width:1.5px;
244234
subgraph SREG["<b>Your VPC</b>"]
245235
SW["<b>Worker(s)</b><br/>Server name:<br/>my-namespace.my-account.tmprl.cloud"]:::worker
246236
SVPCE["<b>VPC Endpoint</b><br/>vpce-…"]:::endpoint
@@ -273,10 +263,10 @@ title: Direct VPCE targeting (High Availability)
273263
---
274264
%%{init: {'themeVariables':{'fontFamily':'Inter, ui-sans-serif, system-ui, sans-serif'},'flowchart':{'nodeSpacing':55,'rankSpacing':70,'curve':'basis','subGraphTitleMargin':{'top':6,'bottom':12}}}}%%
275265
flowchart TD
276-
classDef worker fill:#7C3AED22,stroke:#7C3AED,stroke-width:1px;
277-
classDef ns fill:#59FDA024,stroke:#59FDA0,stroke-width:1px;
278-
classDef endpoint fill:transparent,stroke:#c2c8d2,stroke-width:1px;
279-
classDef region fill:transparent,stroke:#9aa4b2,stroke-width:1.5px;
266+
classDef worker stroke-width:1px;
267+
classDef ns stroke-width:1px;
268+
classDef endpoint stroke-width:1px;
269+
classDef region stroke-width:1.5px;
280270
subgraph HSEC["<b>us-west-2</b> (passive)"]
281271
HWB["<b>Worker(s)</b><br/>Server name<br/><span style='font-family:mono'>namespace.<br/>acct.<br/>tmprl.cloud</span>"]:::worker
282272
HVPB["<b>VPC<br/>Endpoint</b><br/>vpce-…<br/>us-west-2"]:::endpoint

docs/cloud/high-availability/architecture-patterns.mdx

Lines changed: 71 additions & 96 deletions
Large diffs are not rendered by default.

docs/design-patterns/delayed-callback.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ sequenceDiagram
5555
participant W as Workflow
5656
5757
E->>A: POST /webhook (payload)
58-
A->>T: signal_with_start(workflow_id, "payment_received", payload)
58+
A->>T: signal_with_start(workflow_id,<br/>"payment_received", payload)
5959
Note over T: Atomic: start if not running, then signal
60-
T->>W: Start workflow (if not running) + deliver signal
60+
T->>W: Start workflow (if not running)<br/>+ deliver signal
6161
W->>W: Wake up, process payload
6262
W->>W: Execute follow-on activities
6363
```
@@ -78,7 +78,7 @@ sequenceDiagram
7878
participant T as Temporal Cluster
7979
participant E as External Service
8080
81-
C->>T: Start DelayedCallbackWorkflow(url, data, delay)
81+
C->>T: Start DelayedCallbackWorkflow<br/>(url, data, delay)
8282
T->>W: Schedule first task
8383
W->>T: workflow.sleep(delay)
8484
Note over T: Durable timer (survives restarts)
@@ -110,7 +110,7 @@ sequenceDiagram
110110
A-->>W: Return (workflow paused waiting)
111111
Note over W: Waiting for external completion...
112112
E->>CB: POST /callback (result)
113-
CB->>W: complete_async_activity(task_token, result)
113+
CB->>W: complete_async_activity<br/>(task_token, result)
114114
W->>W: Resume with result
115115
```
116116

docs/design-patterns/delayed-retry.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ sequenceDiagram
4141
participant Temporal as Temporal Service
4242
participant API as Rate-Limited API
4343
44-
Workflow->>Temporal: Schedule activity (RetryPolicy: initialInterval=1s)
44+
Workflow->>Temporal: Schedule activity<br/>(RetryPolicy: initialInterval=1s)
4545
Temporal->>+API: Attempt 1
4646
API-->>-Temporal: HTTP 429 — Retry-After: 60s
47-
Note over Temporal: Activity throws ApplicationFailure(nextRetryDelay=60s)
48-
Note over Temporal: Override: wait 60s (ignoring RetryPolicy interval)
47+
Note over Temporal: Activity throws<br/>ApplicationFailure(nextRetryDelay=60s)
48+
Note over Temporal: Override: wait 60s<br/>(ignoring RetryPolicy interval)
4949
Temporal->>+API: Attempt 2
5050
API-->>-Temporal: Success
5151
Temporal-->>Workflow: Result

docs/design-patterns/eager-workflow-start.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ sequenceDiagram
2424
rect rgb(230, 235, 250)
2525
Note over CW,S: Normal Workflow Start
2626
CW->>S: StartWorkflowExecution
27-
S->>S: Matching Service routes task to available Worker
27+
S->>S: Matching Service routes<br/>task to available Worker
2828
S-->>CW: WorkflowTask dispatched via polling
2929
CW->>CW: Execute WorkflowTask
3030
CW->>S: Complete WorkflowTask
@@ -33,7 +33,7 @@ sequenceDiagram
3333
rect rgb(220, 245, 225)
3434
Note over CW,S: Eager Workflow Start (co-located Worker)
3535
CW->>S: StartWorkflowExecution (EnableEagerStart=true)
36-
S-->>CW: WorkflowTask returned inline — no Matching step
36+
S-->>CW: WorkflowTask returned inline<br/>— no Matching step
3737
CW->>CW: Execute WorkflowTask immediately
3838
CW->>S: Complete WorkflowTask
3939
end

docs/design-patterns/early-return-local-activities.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ sequenceDiagram
2828
S->>W: Schedule WorkflowTask
2929
3030
rect rgb(220, 245, 225)
31-
Note over S,W: Phase 1 — Local Activities (in-process, zero server round-trips)
31+
Note over S,W: Phase 1 — Local Activities<br/>(in-process, zero server round-trips)
3232
W->>W: validateTransaction (local)
3333
W->>W: initTransaction (local)
34-
W->>S: Complete WorkflowTask (Phase 1 done, Update result ready)
34+
W->>S: Complete WorkflowTask<br/>(Phase 1 done, Update result ready)
3535
end
3636
3737
S-->>C: Update result returned (~160 ms first response)

docs/design-patterns/request-response-via-updates.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ sequenceDiagram
3434
Workflow->>Workflow: Validate Input
3535
alt Validation Fails
3636
Workflow-->>Client: Error Response
37-
else Validation Succeeds
37+
else Success
3838
Workflow->>State: Modify State
3939
State-->>Workflow: Updated
4040
Workflow-->>Client: Typed Response

docs/design-patterns/signal-with-start.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ sequenceDiagram
3838
activate W
3939
T->>W: Deliver Signal
4040
W->>W: Process Signal
41-
end
42-
alt Workflow already running
41+
else Workflow already running
4342
T->>W: Deliver Signal only (no start)
4443
W->>W: Process Signal
4544
end

docs/design-patterns/sliding-window.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,10 @@ flowchart TD
3939
CAN["continueAsNew\n(startIndex + W)"]
4040
4141
Records --> Parent
42-
Parent -->|"start W children"| C1
42+
Parent <-->|"start W children /<br/>signal: complete"| C1
4343
Parent --> C2
4444
Parent --> C3
4545
46-
C1 -->|"Signal: complete"| Parent
4746
Parent -->|"slot free → start next"| C4
4847
4948
Parent -->|"after W children started"| CAN

0 commit comments

Comments
 (0)