Skip to content

docs: expand Orleans architecture documentation - #10332

Open
ReubenBond wants to merge 3 commits into
dotnet:mainfrom
ReubenBond:reubenbond-docs-orleans-architecture
Open

docs: expand Orleans architecture documentation#10332
ReubenBond wants to merge 3 commits into
dotnet:mainfrom
ReubenBond:reubenbond-docs-orleans-architecture

Conversation

@ReubenBond

@ReubenBond ReubenBond commented Aug 2, 2026

Copy link
Copy Markdown
Member

Expands the Orleans 10 implementation track into an advanced, source-backed architecture guide. It documents runtime topology, activation migration, membership and directory protocols, scheduling and messaging semantics, resource-optimized placement, serialization, persistent streams, provider authoring, and TestingHost internals while correcting stale defaults and APIs.

Microsoft Reviewers: Open in CodeFlow

Copilot AI review requested due to automatic review settings August 2, 2026 21:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 expands the Orleans implementation documentation into an Orleans 10, source-linked architecture track aimed at runtime contributors and advanced users, with new deep-dive pages and substantial rewrites of existing conceptual docs.

Changes:

  • Replaces several high-level implementation pages with Orleans 10-focused architecture explanations (runtime, scheduling, messaging semantics, placement/balancing, membership, grain directory, lifecycle, streams).
  • Adds new architecture pages for runtime flow, activation lifecycle/migration, serialization/codegen internals, and provider authoring patterns.
  • Updates the implementation track landing page to reflect Orleans 10 defaults, invariants, and cross-links between the new pages.
Show a summary per file
File Description
docs/site/src/content/docs/implementation/testing.md Reworks testing content into TestingHost internals and fidelity boundaries.
docs/site/src/content/docs/implementation/streams-implementation/index.md Reframes stream internals around persistent pulling architecture and invariants.
docs/site/src/content/docs/implementation/streams-implementation/azure-queue-streams.md Updates Azure Queue adapter documentation with current APIs and acknowledgement semantics.
docs/site/src/content/docs/implementation/serialization.md Adds a new deep-dive on serialization/codegen, manifests, and extension points.
docs/site/src/content/docs/implementation/scheduler.md Rewrites scheduling doc around turns, WorkItemGroup, and admission vs execution.
docs/site/src/content/docs/implementation/runtime-architecture.md Adds a new end-to-end runtime call-path architecture page.
docs/site/src/content/docs/implementation/provider-authoring.md Adds a new architecture guide for provider authoring patterns and validation/lifecycle.
docs/site/src/content/docs/implementation/orleans-lifecycle.md Refocuses lifecycle documentation on the protocol and ordering invariants.
docs/site/src/content/docs/implementation/messaging-delivery-guarantees.md Expands messaging semantics, routing repair vs retries, and timeout ambiguity.
docs/site/src/content/docs/implementation/load-balancing.md Updates placement documentation to Orleans 10 defaults and opt-in rebalancing/repartitioning.
docs/site/src/content/docs/implementation/index.md Rebuilds the implementation landing page as an Orleans 10 architecture track index.
docs/site/src/content/docs/implementation/grain-directory.md Updates grain directory documentation to distinguish default vs experimental directories.
docs/site/src/content/docs/implementation/cluster-management.md Replaces cluster management page with a membership protocol-focused architecture doc.
docs/site/src/content/docs/implementation/activation-lifecycle.md Adds a new activation lifecycle + migration architecture page.

Copilot's findings

  • Files reviewed: 14/14 changed files
  • Comments generated: 1

Comment thread docs/site/src/content/docs/implementation/testing.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 14/14 changed files
  • Comments generated: 0 new

Copilot AI review requested due to automatic review settings August 5, 2026 13:17

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 14/14 changed files
  • Comments generated: 0 new

ReubenBond added a commit to ReubenBond/orleans that referenced this pull request Aug 5, 2026
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9be838b5-7660-444e-b2c5-bf2e9b373472
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ac311788-910e-401a-b0c5-c714e841aac1
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ac311788-910e-401a-b0c5-c714e841aac1
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ac311788-910e-401a-b0c5-c714e841aac1
@ReubenBond
ReubenBond force-pushed the reubenbond-docs-orleans-architecture branch from 691dd54 to 50b546d Compare August 7, 2026 14:16
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.

2 participants