docs(grains): document distributed collection patterns - #10736
Open
ReubenBond wants to merge 5 commits into
Open
docs(grains): document distributed collection patterns#10736ReubenBond wants to merge 5 commits into
ReubenBond wants to merge 5 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new conceptual documentation guide which explains how Orleans applications can model collections of grains (membership, partitioning, querying, paging, streaming, and consistency boundaries) and wires that guide into the existing grains documentation navigation.
Changes:
- Introduces a new “Model collections of grains” concept article describing common distributed collection patterns and tradeoffs in Orleans.
- Links the new guide from the grains overview page and the grain persistence overview to connect related concepts.
- Adds the new page to the docs table of contents under the “Grains” section.
Show a summary per file
| File | Description |
|---|---|
| docs/site/src/content/docs/toc.yml | Adds the new “Model collections of grains” page to the Grains navigation. |
| docs/site/src/content/docs/grains/model-grain-collections.md | New conceptual guide describing collection modeling patterns, consistency boundaries, paging, and response streaming, with example links. |
| docs/site/src/content/docs/grains/index.md | Links to the new guide from the “advanced features” list and updates ms.date. |
| docs/site/src/content/docs/grains/grain-persistence/index.md | Cross-links to the new guide from the persistence overview and updates ms.date. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 21, 2026 14:33
10f6f54 to
99193e0
Compare
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 21, 2026 17:07
208b194 to
4df241a
Compare
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 22, 2026 07:13
4df241a to
0138df5
Compare
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 23, 2026 07:13
0138df5 to
0f5ba4a
Compare
Contributor
Code coverage77.63% line coverage - 97,597 / 125,722 lines Coverage details
|
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 24, 2026 07:12
0f5ba4a to
c7dc559
Compare
ReubenBond
enabled auto-merge
August 24, 2026 15:11
ReubenBond
marked this pull request as draft
August 24, 2026 15:32
auto-merge was automatically disabled
August 24, 2026 15:32
Pull request was converted to draft
ReubenBond
marked this pull request as ready for review
August 25, 2026 10:08
ReubenBond
enabled auto-merge
August 25, 2026 10:08
ReubenBond
disabled auto-merge
August 26, 2026 07:06
ReubenBond
force-pushed
the
rb-distributed-collections-orleans
branch
from
August 26, 2026 07:16
adfe6b7 to
bc62701
Compare
ReubenBond
enabled auto-merge
August 26, 2026 07:16
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Orleans users have repeatedly asked how to model collections of grains, including membership, querying, filtering, sorting, paging, and bulk operations. The documentation describes grain identity, persistence, transactions, and response streaming separately but does not connect them into application guidance for collection-shaped workloads.
Solution
Add a how-to guide covering bounded owner catalogs, deterministic partitioned registries and indexes, external query stores, consistency boundaries, continuation-token paging, response streaming, and bounded fan-out. Link the guide from the how-to index, grain development overview, persistence documentation, and navigation.
Rationale
Orleans addresses individual logical grains. Applications define collection membership and query semantics using the storage and consistency model appropriate for their workload. Documenting patterns built from existing Orleans primitives gives users concrete guidance without making product or API design decisions for general-purpose distributed collections or queries.
Fixes #1412