Fix incorrect API name in dashboard documentation: AddOrleansDashboard → AddDashboard#9894
Merged
ReubenBond merged 2 commits intomainfrom Jan 29, 2026
Merged
Conversation
Co-authored-by: ReubenBond <203839+ReubenBond@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix incorrect API name in READMEs and documentation
Fix incorrect API name in dashboard documentation: AddOrleansDashboard → AddDashboard
Jan 29, 2026
ReubenBond
approved these changes
Jan 29, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes incorrect API documentation by updating references from the obsolete AddOrleansDashboard to the current public API AddDashboard in dashboard-related README files.
Changes:
- Updated documentation to use the correct
AddDashboardAPI method name for bothISiloBuilderandIClientBuilder
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Dashboard/Orleans.Dashboard/README.md | Updated client builder example to use AddDashboard() instead of obsolete AddOrleansDashboard() |
| playground/DashboardSeparateHost/README.md | Updated two code examples to use AddDashboard() instead of obsolete AddOrleansDashboard() |
This was referenced Feb 9, 2026
Closed
Closed
This was referenced Feb 11, 2026
This was referenced Feb 18, 2026
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.
Dashboard documentation referenced the obsolete
AddOrleansDashboardAPI. The public API for bothISiloBuilderandIClientBuilderis nowAddDashboard.Changes
playground/DashboardSeparateHost/README.md(2 occurrences)src/Dashboard/Orleans.Dashboard/README.md(1 occurrence)Example
Note: The internal
AddOrleansDashboardForSiloCoremethod remains unchanged - it's an implementation detail, not part of the public API surface.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Microsoft Reviewers: Open in CodeFlow