Skip to content

Comments

Fix incorrect API name in dashboard documentation: AddOrleansDashboard → AddDashboard#9894

Merged
ReubenBond merged 2 commits intomainfrom
copilot/update-readmes-api-name
Jan 29, 2026
Merged

Fix incorrect API name in dashboard documentation: AddOrleansDashboard → AddDashboard#9894
ReubenBond merged 2 commits intomainfrom
copilot/update-readmes-api-name

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

Dashboard documentation referenced the obsolete AddOrleansDashboard API. The public API for both ISiloBuilder and IClientBuilder is now AddDashboard.

Changes

  • Updated playground/DashboardSeparateHost/README.md (2 occurrences)
  • Updated src/Dashboard/Orleans.Dashboard/README.md (1 occurrence)

Example

// Before (incorrect)
clientBuilder.AddOrleansDashboard();

// After (correct)
clientBuilder.AddDashboard();

Note: The internal AddOrleansDashboardForSiloCore method remains unchanged - it's an implementation detail, not part of the public API surface.

Original prompt

This section details on the original issue you should resolve

<issue_title>Incorrect API name in READMEs/docs: AddOrleansDashboard is now AddDashboard</issue_title>
<issue_description>As the title says, ISiloBuilder/IClientBuidler do not have an AddOrleansDashboard API, it's now known as AddDashboard. Update READMEs and other strings where the incorrect API name appears.</issue_description>

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


✨ 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

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
Copilot AI requested a review from ReubenBond January 29, 2026 20:43
@ReubenBond ReubenBond marked this pull request as ready for review January 29, 2026 21:02
Copilot AI review requested due to automatic review settings January 29, 2026 21:02
@ReubenBond ReubenBond enabled auto-merge January 29, 2026 21:02
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 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 AddDashboard API method name for both ISiloBuilder and IClientBuilder

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 11, 2026
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.

Incorrect API name in READMEs/docs: AddOrleansDashboard is now AddDashboard

2 participants