Skip to content

cleanup missing rust references #4781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Splutonics wants to merge 3 commits into from
Closed

cleanup missing rust references #4781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412bfa8
cleanup missing rust references, other inconsistencies
Splutonics Jun 27, 2026
e9f445d
a couple more missing links/inconsistencies
Splutonics Jun 27, 2026
4baff7c
Merge branch 'main' into add-rust-to-sdk-langs
Splutonics Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions INFORMATION-ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,6 @@ These cross-cutting pages live outside any SDK folder:
- **Cross-cutting content placement.** Pages like `safe-deployments.mdx`, `worker-performance.mdx`, and
`worker-tuning-reference.mdx` straddle Develop and Deploy to production. `safe-deployments` in particular is about
deployment strategy (versioning vs. patching), which reads more like production deployment guidance.
- **Setup page naming is inconsistent.** Most SDKs use `set-up-your-local-<language>`, TypeScript uses
`install-typescript-sdk`, Rust uses `quickstart`.
- **Legacy versioning files** (`worker-versioning-legacy.mdx`) live in some SDK roots (Go, Java, TypeScript) for a
deprecated pattern. These should either be consolidated or moved to a single deprecation notice.
- **Integrations hub page** (`develop/integrations.mdx`) only links to Java, Python, and TypeScript, even though Ruby
Expand Down
2 changes: 2 additions & 0 deletions docs/cloud/get-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ See our guides for connecting each SDK to your Temporal Cloud Namespace:
- [Connect to Temporal Cloud in .NET](/develop/dotnet/client/temporal-client#connect-to-temporal-cloud)
- [Connect to Temporal Cloud in PHP](/develop/php/client/temporal-client#connect-to-temporal-cloud)
- [Connect to Temporal Cloud in Ruby](/develop/ruby/client/temporal-client#connect-to-temporal-cloud)
- [Connect to Temporal Cloud in Rust](/develop/rust/client/temporal-client#connect-to-temporal-cloud)

## Run your first Workflow

Expand All @@ -71,6 +72,7 @@ See our guides for starting a workflow using each SDK:
- [Start a workflow in .NET](/develop/dotnet/client/temporal-client#start-workflow)
- [Start a workflow in PHP](/develop/php/client/temporal-client#start-workflow-execution)
- [Start a workflow in Ruby](/develop/ruby/client/temporal-client#start-workflow)
- [Start a workflow in Rust](/develop/rust/client/temporal-client#start-workflow-execution)

## Invite your team

Expand Down
4 changes: 2 additions & 2 deletions docs/develop/dotnet/workflows/message-passing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: message-passing
title: Message passing - .NET SDK
sidebar_label: Message passing
title: Workflow message passing - .NET SDK
sidebar_label: Messages
description: Develop with Queries, Signals, and Updates with the Temporal .NET SDK.
toc_max_heading_level: 3
keywords:
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/ruby/workflows/message-passing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: message-passing
title: Message passing - Ruby SDK
sidebar_label: Message passing
title: Workflow message passing - Ruby SDK
sidebar_label: Messages
description: Develop with Queries, Signals, and Updates using the Temporal Ruby SDK.
toc_max_heading_level: 3
keywords:
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/ruby/workflows/versioning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ There are two primary Versioning methods that you can use:

Temporal's [Worker Versioning](/production-deployment/worker-deployments/worker-versioning) feature allows you to tag your Workers and programmatically roll them out in Deployment Versions, so that old Workers can run old code paths and new Workers can run new code paths. This way, you can pin your Workflows to specific revisions, avoiding the need for patching.

## Versioning with Patching {/* #ruby-sdk-patching-api */}
## Versioning with Patching {/* #patching */}

### Adding a patch

Expand Down
8 changes: 4 additions & 4 deletions docs/develop/rust/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ import * as Components from '@site/src/components';

## Install and get started

You can find detailed installation instructions for the Rust SDK in the [Quickstart](/develop/rust/quickstart).
You can find detailed installation instructions for the Rust SDK in the [Quickstart](/develop/rust/set-up-your-local-rust).

Once your local Temporal Service is set up, continue building with the following resources:

- [Develop a Workflow](/develop/rust/workflows/basics)
- [Develop an Activity](/develop/rust/activities/basics)
- [Start an Activity execution](/develop/rust/activities/execution)
- [Run Worker processes](/develop/rust/workers/worker-process)
- [Run Worker processes](/develop/rust/workers/run-worker-process)

## [Workflows](/develop/rust/workflows)

Expand All @@ -45,7 +45,7 @@ Once your local Temporal Service is set up, continue building with the following

## [Workers](/develop/rust/workers)

- [Worker processes](/develop/rust/workers/worker-process)
- [Worker processes](/develop/rust/workers/run-worker-process)

## [Temporal Client](/develop/rust/client)

Expand All @@ -57,7 +57,7 @@ Once your local Temporal Service is set up, continue building with the following

## Temporal Rust Technical Resources

- [Rust SDK Quickstart - Setup Guide](/develop/rust/quickstart)
- [Rust SDK Quickstart - Setup Guide](/develop/rust/set-up-your-local-rust)
- [Rust API Documentation](https://docs.rs/temporalio-sdk/latest/temporalio_sdk/)
- [Rust SDK GitHub](https://github.com/temporalio/sdk-core/tree/master/crates/sdk)

Expand Down
6 changes: 3 additions & 3 deletions docs/develop/rust/quickstart.mdx → docs/develop/rust/set-up.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: quickstart
id: set-up-your-local-rust
title: Quickstart - Rust SDK
sidebar_label: Quickstart
description: Configure your local development environment to get started developing with Temporal and the Rust SDK
description: Configure your local development environment to get started developing with Temporal
keywords:
- quickstart
- getting started
Expand Down Expand Up @@ -304,7 +304,7 @@ Now that you have the basics working, explore the following resources to build m

- [Develop a Workflow](/develop/rust/workflows/basics) - Learn how to write complex workflow logic
- [Develop an Activity](/develop/rust/activities/basics) - Understand activity patterns and best practices
- [Worker Processes](/develop/rust/workers/worker-process) - Configure and scale workers
- [Worker Processes](/develop/rust/workers/run-worker-process) - Configure and scale workers
- [Using the Temporal Client](/develop/rust/client/temporal-client) - Start workflows and interact with the Temporal Service

<CallToAction href="https://learn.temporal.io/courses/">
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/rust/workers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ import * as Components from '@site/src/components';

## Workers

- [Worker processes](/develop/rust/workers/worker-process)
- [Worker processes](/develop/rust/workers/run-worker-process)
2 changes: 1 addition & 1 deletion docs/develop/rust/workers/worker-process.mdx → ...velop/rust/workers/run-worker-process.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: worker-process
id: run-worker-process
title: Worker processes - Rust SDK
description: Shows how to run Worker processes with the Rust SDK
sidebar_label: Worker processes
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/typescript/workflows/message-passing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: message-passing
title: Workflow message passing - TypeScript SDK
sidebar_label: Message passing
sidebar_label: Messages
description: Develop with Queries, Signals, and Updates with the Temporal Typescript SDK.
toc_max_heading_level: 3
keywords:
Expand Down
1 change: 1 addition & 0 deletions docs/encyclopedia/activities/activity-definition.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ For full SDK-specific guides, see:
- [How to develop an Activity Definition using the Python SDK](/develop/python/activities/basics)
- [How to develop an Activity Definition using the TypeScript SDK](/develop/typescript/activities/basics)
- [How to develop an Activity Definition using the .NET SDK](/develop/dotnet/activities/basics)
- [How to develop an Activity Definition using the Ruby SDK](/develop/ruby/activities/basics)
- [How to develop an Activity Definition using the Rust SDK](/develop/rust/activities/basics)

The term 'Activity Definition' is used to refer to the full set of primitives in any given language SDK that provides an access point to an Activity Function Definition——the method or function that is invoked for an [Activity Task Execution](/tasks#activity-task-execution).
Expand Down
3 changes: 3 additions & 0 deletions docs/encyclopedia/activities/activity-execution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ An Activity Execution is the full chain of [Activity Task Executions](/tasks#act
- [How to start an Activity Execution using the Python SDK](/develop/python/activities/execution)
- [How to start an Activity Execution using the TypeScript SDK](/develop/typescript/activities/execution)
- [How to start an Activity Execution using the .NET SDK](/develop/dotnet/activities/execution)
- [How to start an Activity Execution using the Ruby SDK](/develop/ruby/activities/execution)
- [How to start an Activity Execution using the Rust SDK](/develop/rust/activities/execution)

:::

Expand Down Expand Up @@ -131,6 +133,7 @@ How to complete an Activity Asynchronously in:
- [Python](/develop/python/activities/asynchronous-activity)
- [TypeScript](/develop/typescript/activities/asynchronous-activity)
- [.NET](/develop/dotnet/activities/asynchronous-activity)
- [Ruby](/develop/ruby/activities/asynchronous-activity)

### When to use Async Completion

Expand Down
5 changes: 5 additions & 0 deletions docs/encyclopedia/detecting-activity-failures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ In other words, it's a limit for how long an Activity Task can be enqueued.
<RelatedReadItem path="/develop/python/activities/timeouts" text="Set a Schedule-To-Start Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/activities/timeouts" text="Set a Schedule-To-Start Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/activities/timeouts" text="Set a Schedule-To-Start Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/activities/timeouts" text="Set a Schedule-To-Start Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/activities/timeouts" text="Set a Schedule-To-Start Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -86,6 +87,7 @@ A Start-To-Close Timeout is the maximum time allowed for a single [Activity Task
<RelatedReadItem path="/develop/python/activities/timeouts" text="Set a Start-To-Close Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/activities/timeouts" text="Set a Start-To-Close Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/activities/timeouts" text="Set a Start-To-Close Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/activities/timeouts" text="Set a Start-To-Close Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/activities/timeouts" text="Set a Start-To-Close Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -139,6 +141,7 @@ A Schedule-To-Close Timeout is the maximum amount of time allowed for the overal
<RelatedReadItem path="/develop/python/activities/timeouts" text="Set a Schedule-To-Close Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/activities/timeouts" text="Set a Schedule-To-Close Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/activities/timeouts" text="Set a Schedule-To-Close Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/activities/timeouts" text="Set a Schedule-To-Close Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/activities/timeouts" text="Set a Schedule-To-Close Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -180,6 +183,7 @@ Each ping informs the Temporal Service that the Activity Execution is making pro
<RelatedReadItem path="/develop/python/activities/timeouts#activity-heartbeats" text="Heartbeat an Activity using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/activities/timeouts#activity-heartbeat-timeout" text="Heartbeat an Activity using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/activities/timeouts#activity-heartbeats" text="Heartbeat an Activity using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/activities/timeouts#activity-heartbeats" text="Heartbeat an Activity using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/activities/timeouts#activity-heartbeats" text="Heartbeat an Activity using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -263,6 +267,7 @@ A Heartbeat Timeout is the maximum time between [Activity Heartbeats](#activity-
<RelatedReadItem path="/develop/python/activities/timeouts#heartbeat-timeout" text="Set a Heartbeat Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/activities/timeouts#activity-heartbeat-timeout" text="Set a Heartbeat Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/activities/timeouts#heartbeat-timeout" text="Set a Heartbeat Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/activities/timeouts#heartbeat-timeout" text="Set a Heartbeat Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/activities/timeouts#heartbeat-timeout" text="Set a Heartbeat Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down
3 changes: 3 additions & 0 deletions docs/encyclopedia/detecting-workflow-failures.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ A Workflow Execution Timeout is the maximum time that a Workflow Execution can b
<RelatedReadItem path="/develop/python/workflows/timeouts" text="Set a Workflow Execution Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/workflows/timeouts" text="Set a Workflow Execution Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/workflows/timeouts" text="Set a Workflow Execution Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/workflows/timeouts" text="Set a Workflow Execution Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/workflows/timeouts" text="Set a Workflow Execution Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -69,6 +70,7 @@ A Workflow Run Timeout restricts the maximum duration of a single Workflow Run.
<RelatedReadItem path="/develop/python/workflows/timeouts" text="Set a Workflow Run Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/workflows/timeouts" text="Set a Workflow Run Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/workflows/timeouts" text="Set a Workflow Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/workflows/timeouts" text="Set a Workflow Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/workflows/timeouts" text="Set a Workflow Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down Expand Up @@ -96,6 +98,7 @@ This Timeout is primarily available to recognize whether a Worker has gone down
<RelatedReadItem path="/develop/python/workflows/timeouts" text="Set a Workflow Task Timeout using the Python SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/typescript/workflows/timeouts" text="Set a Workflow Task Timeout using the TypeScript SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/dotnet/workflows/timeouts" text="Set a Workflow Task Timeout using the .NET SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/ruby/workflows/timeouts" text="Set a Workflow Task Timeout using the Ruby SDK" archetype="feature-guide" />
<RelatedReadItem path="/develop/rust/workflows/timeouts" text="Set a Workflow Task Timeout using the Rust SDK" archetype="feature-guide" />
</RelatedReadContainer>

Expand Down
10 changes: 10 additions & 0 deletions docs/encyclopedia/retry-policies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,11 @@ Try out the [Activity retry simulator](/develop/activity-retry-simulator) to vis
text="Set a custom Retry Policy for an Activity in TypeScript"
archetype="feature-guide"
/>
<RelatedReadItem
path="/develop/ruby/activities/timeouts#activity-retries"
text="Set a custom Retry Policy for an Activity in Ruby"
archetype="feature-guide"
/>
<RelatedReadItem
path="/develop/rust/activities/timeouts#activity-retries"
text="Set a custom Retry Policy for an Activity in Rust"
Expand Down Expand Up @@ -100,6 +105,11 @@ Try out the [Activity retry simulator](/develop/activity-retry-simulator) to vis
text="Set a Retry Policy for a Workflow in TypeScript"
archetype="feature-guide"
/>
<RelatedReadItem
path="/develop/ruby/workflows/timeouts#workflow-retries"
text="Set a Retry Policy for a Workflow in Ruby"
archetype="feature-guide"
/>
<RelatedReadItem
path="/develop/rust/workflows/timeouts#workflow-retries"
text="Set a Retry Policy for a Workflow in Rust"
Expand Down
1 change: 1 addition & 0 deletions docs/encyclopedia/temporal-sdks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Each Temporal SDK targets a specific programming language.
- [.NET SDK feature guides](/develop/dotnet)
- [Ruby SDK feature guides](/develop/ruby/)
- [PHP SDK feature guides](/develop/php)
- [Rust SDK feature guides](/develop/rust)

Despite supporting multiple languages, and supporting many features, Temporal SDKs aim to make developers feel at home in their language.

Expand Down
10 changes: 9 additions & 1 deletion docs/encyclopedia/workers/task-queues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ There are five places where the name of the Task Queue can be set by the develop
- [How to start a Workflow Execution using the Python SDK](/develop/python/client/temporal-client#start-workflow-execution)
- [How to start a Workflow Execution using the TypeScript SDK](/develop/typescript/client/temporal-client#start-workflow-execution)
- [How to start a Workflow Execution using the .NET SDK](/develop/dotnet/client/temporal-client#start-workflow)
- [How to start a Workflow Execution using the Ruby SDK](/develop/ruby/client/temporal-client#start-workflow)
- [How to start a Workflow Execution using the Rust SDK](/develop/rust/client/temporal-client#start-workflow-execution)

2. A Task Queue name must be set when creating a Worker Entity and when running a Worker Process:

Expand All @@ -93,7 +95,9 @@ There are five places where the name of the Task Queue can be set by the develop
- [How to run a development Worker using the PHP SDK](/develop/php/workers/run-worker-process#run-a-dev-worker)
- [How to run a development Worker using the Python SDK](/develop/python/workers/run-worker-process#run-a-dev-worker)
- [How to run a development Worker using the TypeScript SDK](/develop/typescript/workers/run-worker-process#run-a-dev-worker)
- [How to run a development Worker using the .NET SDK](/develop/dotnet/workers/run-worker-process)<br /><br />
- [How to run a development Worker using the .NET SDK](/develop/dotnet/workers/run-worker-process)
- [How to run a development Worker using the Ruby SDK](/develop/ruby/workers/run-worker-process#run-worker-process)
- [How to run a development Worker using the Rust SDK](/develop/rust/workers/run-worker-process#run-a-dev-worker)<br /><br />
- [How to connect a Go SDK Worker to Temporal Cloud](/develop/go/workers/run-worker-process#connect-to-temporal-cloud)
- [How to run a Temporal Cloud Worker using the TypeScript SDK](/develop/typescript/workers/run-worker-process#run-a-temporal-cloud-worker)

Expand All @@ -113,6 +117,8 @@ There are five places where the name of the Task Queue can be set by the develop
- [How to start an Activity Execution using the Python SDK](/develop/python/activities/execution)
- [How to start an Activity Execution using the TypeScript SDK](/develop/typescript/activities/execution)
- [How to start an Activity Execution using the .NET SDK](/develop/dotnet/activities/execution)
- [How to start an Activity Execution using the Ruby SDK](/develop/ruby/activities/execution)
- [How to start an Activity Execution using the Rust SDK](/develop/rust/activities/execution)

4. A Task Queue name can be provided when spawning a Child Workflow Execution:

Expand All @@ -125,6 +131,8 @@ There are five places where the name of the Task Queue can be set by the develop
- [How to start a Child Workflow Execution using the Python SDK](/develop/python/workflows/child-workflows)
- [How to start a Child Workflow Execution using the TypeScript SDK](/develop/typescript/workflows/child-workflows)
- [How to start a Child Workflow Execution using the .NET SDK](/develop/dotnet/workflows/child-workflows)
- [How to start a Child Workflow Execution using the Ruby SDK](/develop/ruby/workflows/child-workflows)
- [How to start a Child Workflow Execution using the Rust SDK](/develop/rust/workflows/child-workflows)

5. A Task Queue name can be provided when creating a Nexus Endpoint.
Nexus Endpoints route requests to the target Task Queue.
Expand Down
Loading