Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 20, 2025

Summary

Fixes the issue where the Orleans streaming quickstart guide doesn't mention that the Microsoft.Orleans.Streaming NuGet package is required for Orleans 7.0, leading to confusion when users try to use the AddMemoryStreams extension method.

Problem

Users following the quickstart guide encounter errors when attempting to call AddMemoryStreams because the required NuGet package isn't documented. The guide jumps directly into configuration code without mentioning the prerequisite package installation.

Solution

Added a clear statement in the Orleans 7.0 section of the quickstart that specifies:

  • The Microsoft.Orleans.Streaming NuGet package is required
  • The package provides streaming functionality for both client and server
  • It includes the AddMemoryStreams extension method used in the guide
  • A direct link to the NuGet package page

The addition follows the same documentation pattern used in other Orleans streaming pages (such as Azure Queue streams) and is placed prominently in the "Required configurations" section before the configuration code examples.

Notes

This change only affects the Orleans 7.0 section, as Orleans 3.x uses the Simple Message Stream provider which is included in the Microsoft.Orleans.OrleansProviders package (already part of the Server and Client meta-packages).

Closes #[issue-number]

Original prompt

This section details on the original issue you should resolve

<issue_title>Orleans streaming quickstart doesn't mention that a nuget package is required</issue_title>
<issue_description>### Type of issue

Missing Info

Description

Nuget package Microsoft.Orleans.Streaming is required for streaming, but this isn't mentioned on the Quick Start page, which leads to confusion when trying to add AddMemoryStreams to the silo builder.

Page URL

https://learn.microsoft.com/en-us/dotnet/orleans/streaming/streams-quick-start?pivots=orleans-7-0

Content source URL

https://github.com/dotnet/docs/blob/main/docs/orleans/streaming/streams-quick-start.md

Document Version Independent Id

f213f225-7aea-30ba-f339-a2e20145d767

Article author

@IEvangelist

Metadata

  • ID: 02155c60-ec05-e75d-470d-f41e52c518df
  • Service: dotnet-orleans</issue_description>

<agent_instructions>Please address this issue</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #39640


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.


Internal previews

📄 File 🔗 Preview link
docs/orleans/streaming/streams-quick-start.md docs/orleans/streaming/streams-quick-start

…7.0 streaming quickstart

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Add missing nuget package information for Orleans streaming Add missing Microsoft.Orleans.Streaming NuGet package requirement to Orleans 7.0 streaming quickstart Oct 20, 2025
Copilot finished work on behalf of IEvangelist October 20, 2025 15:43
Copilot AI requested a review from IEvangelist October 20, 2025 15:43
@IEvangelist IEvangelist marked this pull request as ready for review October 20, 2025 18:13
@IEvangelist IEvangelist requested a review from a team as a code owner October 20, 2025 18:13
@IEvangelist IEvangelist requested review from Copilot and removed request for a team October 20, 2025 18:13
@IEvangelist IEvangelist enabled auto-merge (squash) October 20, 2025 18:13
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR addresses a documentation gap in the Orleans streaming quickstart guide by adding information about the required Microsoft.Orleans.Streaming NuGet package for Orleans 7.0. Users were encountering errors when attempting to use the AddMemoryStreams extension method because the guide didn't mention the prerequisite package installation.

Key Changes:

  • Added explicit documentation of the Microsoft.Orleans.Streaming NuGet package requirement
  • Placed the package information in the "Required configurations" section before code examples
  • Included a direct link to the NuGet package page


In this guide, you use a memory-based stream that uses grain messaging to send stream data to subscribers. You use the in-memory storage provider to store lists of subscriptions. Using memory-based mechanisms for streaming and storage is intended only for local development and testing, not for production environments.

Orleans streaming requires the [Microsoft.Orleans.Streaming](https://www.nuget.org/packages/Microsoft.Orleans.Streaming) NuGet package. This package provides the streaming functionality for both the client and server, including the `AddMemoryStreams` extension method used in this guide.
Copy link

Copilot AI Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI-generated content must include the ai-usage: ai-assisted frontmatter key/value pair. Since this PR was created with AI assistance (as indicated by the Copilot coding agent suffix in the description), please add this frontmatter to the document if it's not already present.

Copilot generated this review using guidance from repository custom instructions.
Copy link
Contributor

@meaghanlewis meaghanlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Orleans streaming quickstart doesn't mention that a nuget package is required

3 participants