Skip to content

docs: align C# SDK documentation - #989

Merged
jonathannorris merged 5 commits into
mainfrom
docs-sdk-csharp
Aug 7, 2026
Merged

docs: align C# SDK documentation#989
jonathannorris merged 5 commits into
mainfrom
docs-sdk-csharp

Conversation

@jonathannorris

@jonathannorris jonathannorris commented Aug 6, 2026

Copy link
Copy Markdown
Member

Summary

  • Correct repeated Local NuGet badges.
  • Align option defaults and limits with the current .NET SDK.
  • Document target framework compatibility and client disposal.

Validation

  • git diff --check passed

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 6, 2026

Copy link
Copy Markdown

Deploying devcycle-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 63bf690
Status: ✅  Deploy successful!
Preview URL: https://5bfa8214.devcycle-docs.pages.dev
Branch Preview URL: https://docs-sdk-csharp.devcycle-docs.pages.dev

View logs

@jonathannorris
jonathannorris marked this pull request as ready for review August 6, 2026 18:25

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

Note

Copilot was unable to run its full agentic suite in this review.

Updates the .NET Server SDK docs to correct NuGet badge links and improve user guidance around installation/runtime behavior.

Changes:

  • Fix the “Nuget Local” badge to reference the correct package/version across .NET docs pages.
  • Add guidance about disposing SDK clients and supported target frameworks.
  • Update option documentation for polling and event-queue limits.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
docs/sdk/server-side-sdks/dotnet/dotnet.md Fixes “Nuget Local” badge to reference the correct local package version.
docs/sdk/server-side-sdks/dotnet/dotnet-usage.md Fixes local badge and adds disposal guidance for SDK clients.
docs/sdk/server-side-sdks/dotnet/dotnet-install.md Fixes local badge and documents target frameworks for the packages.
docs/sdk/server-side-sdks/dotnet/dotnet-gettingstarted.md Fixes local badge and revises documented defaults/constraints for several options.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/sdk/server-side-sdks/dotnet/dotnet-usage.md Outdated
Comment thread docs/sdk/server-side-sdks/dotnet/dotnet-install.md Outdated
Comment thread docs/sdk/server-side-sdks/dotnet/dotnet-gettingstarted.md Outdated
Comment thread docs/sdk/server-side-sdks/dotnet/dotnet-gettingstarted.md
Comment thread docs/sdk/server-side-sdks/dotnet/dotnet-gettingstarted.md
@jonathannorris
jonathannorris enabled auto-merge (squash) August 7, 2026 18:11
@jonathannorris
jonathannorris merged commit c1c42ae into main Aug 7, 2026
5 checks passed
@jonathannorris
jonathannorris deleted the docs-sdk-csharp branch August 7, 2026 18:13
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.

3 participants