Skip to content

docs: align C# SDK documentation #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathannorris merged 5 commits into from
Aug 7, 2026
Merged

docs: align C# SDK documentation #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c7eef3
docs: align C# SDK documentation
jonathannorris Aug 6, 2026
ebd0347
docs: clarify dotnet polling behavior
jonathannorris Aug 6, 2026
f93c2c2
docs: simplify dotnet option descriptions
jonathannorris Aug 6, 2026
01d2355
docs: restore dotnet polling minimum
jonathannorris Aug 6, 2026
63bf690
docs: clarify dotnet package and option guidance
jonathannorris Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/sdk/server-side-sdks/dotnet/dotnet-gettingstarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props: { icon: material-symbols:rocket }
---

[![Nuget Cloud](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Local)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

## Cloud Bucketing - Initializing SDK
Expand Down Expand Up @@ -126,12 +126,12 @@ namespace Example {
| DevCycle Option | Type | Description |
| ----------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| enableEdgeDB | bool | Enables the usage of EdgeDB for DevCycle that syncs User Data to DevCycle. <br />NOTE: This is only available with Cloud Bucketing enabled. |
| configPollingIntervalMs | int | Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 10 seconds, minimum value is 1 second. |
| configPollingTimeoutMs | int | Controls the request timeout to fetch new environment config changes, defaults to 5 seconds, must be less than the configPollingIntervalMS value, minimum value is 1 second. |
| configPollingIntervalMs | int | Controls the polling interval in milliseconds to fetch new environment config changes, defaults to 1 second, with a minimum value of 1 second. |
| configPollingTimeoutMs | int | Controls the request timeout to fetch new environment config changes, defaults to 5 seconds. Values below the configured polling interval are raised to that interval. |
| disableAutomaticEvents | bool | Disables logging of sdk generated events (e.g. aggVariableEvaluated, aggVariableDefaulted) to DevCycle. |
| disableCustomEvents | bool | Disables logging of custom events, from `track()` method, and user data to DevCycle. |
| flushEventQueueSize | int | Controls the maximum size the event queue can grow to until a flush is forced. Defaults to `1000`. |
| maxEventsInQueue | int | Controls the maximum size the event queue can grow to until events are dropped. Defaults to `2000`. |
| maxEventsInQueue | int | Controls the maximum size the event queue can grow to until events are dropped. Defaults to `2000`, with a maximum of `20000`. |
Comment thread
jonathannorris marked this conversation as resolved.
Comment thread
jonathannorris marked this conversation as resolved.
| eventRequestChunkSize | int | Count of events to chunk per event upload request. Defaults to `100`. |
| eventFlushIntervalMs | int | Controls the interval between flushing events to the DevCycle servers. Defaults to `10000`. |
| cdnUri | string | Contact support for usage instructions. |
Expand Down
4 changes: 3 additions & 1 deletion docs/sdk/server-side-sdks/dotnet/dotnet-install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props: { icon: material-symbols:install-desktop }
---

[![Nuget Cloud](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Local)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

## AI-Powered Install
Expand All @@ -20,6 +20,8 @@ import PromptContent from '!!raw-loader!@site/static/ai-prompts/dotnet.md'

<AIPromptCopyButton promptContent={PromptContent} />

The Cloud package targets .NET Standard 2.0 and .NET Standard 2.1. The Local package targets .NET Standard 2.0. Confirm that your application target supports the selected framework before installing.

## Local Bucketing

[//]: # 'wizard-install-start'
Expand Down
4 changes: 3 additions & 1 deletion docs/sdk/server-side-sdks/dotnet/dotnet-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props: { icon: material-symbols:toggle-on }
---

[![Nuget Cloud](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Local)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)

[//]: # 'wizard-evaluate-start'
Expand Down Expand Up @@ -116,6 +116,8 @@ or the SDK is not able to make requests to the DevCycle API directly. The instal

See the [SDK Proxy](../../sdk-proxy/index.md) section for more information.

`DevCycleCloudClient` and `DevCycleLocalClient` implement `IDisposable`. Dispose the client during application shutdown to stop polling, realtime connections, timers, and event queue resources.

## Realtime Updates

This feature reduces the number of polling requests that are made to the DevCycle Config CDN, and instead will
Expand Down
3 changes: 1 addition & 2 deletions docs/sdk/server-side-sdks/dotnet/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ See [Here](/sdk/features#local-and-cloud-bucketing) for more information.
The SDK is available as a package on Nuget. It is also open source and can be viewed on Github.

[![Nuget Cloud](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Cloud/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Cloud)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![Nuget Local](https://badgen.net/nuget/v/DevCycle.SDK.Server.Local)](https://www.nuget.org/packages/DevCycle.SDK.Server.Local/)
[![GitHub](https://img.shields.io/github/stars/devcyclehq/dotnet-server-sdk.svg?style=social&label=Star&maxAge=2592000)](https://github.com/DevCycleHQ/dotnet-server-sdk)


Loading