docs: align examples with actual Future/Result implementation patterns

[Copilot]

Documentation and Examples Review - Complete ✅

All Completed Tasks:

• Getting Started Guide (website/docs/guide/getting-started.md)

  • ✅ Fixed activities to show Future/Result pattern
  • ✅ Updated client example to show Future/Result pattern
  • ✅ Fixed worker setup example
  • ✅ Already uses destructured context
  • ✅ Simplified variable naming (resultFuture -> future)

• Activity Handlers Guide (website/docs/guide/activity-handlers.md)

  • ✅ Updated all examples to show Future/Result pattern with ActivityError
  • ✅ Fixed dependency injection examples
  • ✅ Updated testability examples

• Worker Implementation Guide (website/docs/guide/worker-implementation.md)

  • ✅ Added Future/Result pattern to activities examples
  • ✅ Clarified that workflows receive plain values from activities
  • ✅ Updated error handling section with proper ActivityError usage
  • ✅ Fixed worker setup example
  • ✅ Destructured context in all workflow examples
  • ✅ Fixed comment: "activities is fully typed"

• Worker Usage Guide (website/docs/guide/worker-usage.md)

  • ✅ Removed non-existent createWorker function
  • ✅ Updated to use standard Worker.create
  • ✅ Fixed child workflow examples to show Result pattern
  • ✅ Updated all worker startup examples
  • ✅ Destructured context in all workflow examples

• Result Pattern Guide (website/docs/guide/result-pattern.md)

  • ✅ Clarified activities use Future/Result internally
  • ✅ Fixed workflow examples to show activities return plain values
  • ✅ Updated benefits section with correct patterns
  • ✅ Child workflow examples remain correct (they do use Result)
  • ✅ Destructured context in all workflow examples

• Entry Points Guide (website/docs/guide/entry-points.md)

  • ✅ Destructured context in all workflow examples

• Client Usage Guide (website/docs/guide/client-usage.md)

  • ✅ Fixed examples to show Future/Result pattern from client
  • ✅ Updated startWorkflow to show Result handling
  • ✅ Simplified variable naming (resultFuture -> future)

• Client README (packages/client/README.md)

  • ✅ Fixed client creation syntax to include Client instance

• Worker README (packages/worker/README.md)

  • ✅ Added Future/Result pattern to activities example
  • ✅ Removed deprecated createWorker function
  • ✅ Fixed to use standard Worker.create
  • ✅ Destructured context in all workflow examples (including processOrder example)

• Main README (README.md)

  • ✅ Updated quick example to show Future/Result pattern for activities

• Sample READMEs

  • ✅ Fixed order-processing-client README references
  • ✅ Updated order-processing-worker README
  • ✅ Removed references to non-existent worker-boxed sample

• Homepage (website/docs/index.md)

  • ✅ Fixed createWorker references to use Worker.create
  • ✅ Updated client example to show Future/Result pattern
  • ✅ Added proper Connection setup
  • ✅ Already uses destructured context
  • ✅ Simplified variable naming (resultFuture -> future)

• Formatting

  • ✅ Fixed trailing whitespace issues identified by CI

Summary of Changes

All documentation and README files have been reviewed and updated to reflect the actual code implementation:

1. Activities always use Future.fromPromise() with .mapError() and .mapOk()
2. ActivityError is always used to wrap errors in activities
3. Workflows receive plain values from activities (Result unwrapped by framework)
4. Workflows destructure context parameter: ({ activities }, input) => {} - ALL instances fixed
5. Clients receive Future<Result> from workflow execution methods
6. Child workflows use the Result pattern for explicit error handling
7. Worker setup uses standard Worker.create() from @temporalio/worker
8. All examples are now consistent and match the actual implementation
9. Code formatting has been fixed to pass CI checks
10. Variable naming simplified (resultFuture -> future) for better readability

Original prompt

review the whole website and every readme, some examples are not up to date with code

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[btravers]

@copilot format because CI is KO

[btravers]

@copilot retry

[Copilot]

@copilot retry

Formatting fixed in c9bd000. Ran oxfmt to remove trailing whitespace that was causing CI to fail.

[Copilot]

Pull request overview

This PR updates all documentation and README files to accurately reflect the current codebase implementation, specifically around the Result/Future pattern usage, worker creation, and context destructuring.

Key Changes:

• Updated all activity examples to show the Future.fromPromise() pattern with ActivityError wrapping
• Fixed worker creation examples to use standard Worker.create() instead of the non-existent createWorker function
• Updated workflow implementations to destructure context parameters
• Clarified that workflows receive plain values from activities (Result unwrapped by framework) while child workflows use the Result pattern

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
website/docs/index.md	Updated client and worker examples to show Result/Future pattern and correct Worker.create usage
website/docs/guide/worker-usage.md	Removed createWorker references, updated child workflow examples to show Result pattern
website/docs/guide/worker-implementation.md	Added Future/Result pattern to activities, clarified workflow receives plain values, destructured context
website/docs/guide/result-pattern.md	Clarified activities use Future/Result internally while workflows use try/catch for activity calls
website/docs/guide/getting-started.md	Fixed worker setup and client examples to show Result/Future pattern
website/docs/guide/entry-points.md	Destructured context in workflow examples
website/docs/guide/client-usage.md	Updated to show Future/Result pattern from client perspective
website/docs/guide/activity-handlers.md	Updated all activity examples to show Future/Result pattern with ActivityError
samples/order-processing-worker/README.md	Updated description to reflect Result/Future pattern usage
samples/order-processing-client/README.md	Fixed references to non-existent worker-boxed sample, updated to worker-nestjs
packages/worker/README.md	Added Future/Result pattern to activities, removed createWorker, destructured context
packages/client/README.md	Fixed client creation to include Client instance
README.md	Updated quick example to show Future/Result pattern for activities

Comments suppressed due to low confidence (1)

website/docs/guide/worker-usage.md:1

• The variable name 'handleResult' is confusing as it suggests a result when it actually contains a Result wrapping a workflow handle. Consider naming it 'handleOrError' or 'startResult' to better reflect that it's the result of starting (not the workflow result).

# Worker Usage