-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Updating docs for pkgs/sdk/server-ai
- Loading branch information
1 parent
cbee4f0
commit 186274f
Showing
282 changed files
with
107,713 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| <!DOCTYPE html> | ||
| <!--[if IE]><![endif]--> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
| <title>Changelog | LaunchDarkly Dotnet Server AI SDK </title> | ||
| <meta name="viewport" content="width=device-width"> | ||
| <meta name="title" content="Changelog | LaunchDarkly Dotnet Server AI SDK "> | ||
|
|
||
|
|
||
| <link rel="shortcut icon" href="favicon.ico"> | ||
| <link rel="stylesheet" href="styles/docfx.vendor.min.css"> | ||
| <link rel="stylesheet" href="styles/docfx.css"> | ||
| <link rel="stylesheet" href="styles/main.css"> | ||
| <meta property="docfx:navrel" content=""> | ||
| <meta property="docfx:tocrel" content=""> | ||
|
|
||
| <meta property="docfx:rel" content=""> | ||
|
|
||
| </head> | ||
| <body data-spy="scroll" data-target="#affix" data-offset="120"> | ||
| <div id="wrapper"> | ||
| <header> | ||
|
|
||
| <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> | ||
| <div class="container"> | ||
| <div class="navbar-header"> | ||
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> | ||
| <span class="sr-only">Toggle navigation</span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| </button> | ||
|
|
||
| <a class="navbar-brand" href="index.html"> | ||
| <img id="logo" class="svg" src="logo.svg" alt="LaunchDarkly Dotnet Server AI SDK"> | ||
| </a> | ||
| </div> | ||
| <div class="collapse navbar-collapse" id="navbar"> | ||
| <form class="navbar-form navbar-right" role="search" id="search"> | ||
| <div class="form-group"> | ||
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> | ||
| </div> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div class="subnav navbar navbar-default"> | ||
| <div class="container hide-when-search" id="breadcrumb"> | ||
| <ul class="breadcrumb"> | ||
| <li></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container body-content"> | ||
|
|
||
| <div id="search-results"> | ||
| <div class="search-list">Search Results for <span></span></div> | ||
| <div class="sr-items"> | ||
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> | ||
| </div> | ||
| <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul> | ||
| </div> | ||
| </div> | ||
| <div role="main" class="container body-content hide-when-search"> | ||
| <div class="article row grid"> | ||
| <div class="col-md-10"> | ||
| <article class="content wrap" id="_content" data-uid=""> | ||
| <h1 id="changelog">Changelog</h1> | ||
|
|
||
| <h2 id="010-2024-11-12">0.1.0 (2024-11-12)</h2> | ||
| <h3 id="features">Features</h3> | ||
| <ul> | ||
| <li>release server-ai (<a href="https://github.com/launchdarkly/dotnet-core/issues/38">#38</a>) (<a href="https://github.com/launchdarkly/dotnet-core/commit/cf07fef86f6ce86ed2e76f2a9f7115617f0e0738">cf07fef</a>)</li> | ||
| </ul> | ||
|
|
||
| </article> | ||
| </div> | ||
|
|
||
| <div class="hidden-sm col-md-2" role="complementary"> | ||
| <div class="sideaffix"> | ||
| <div class="contribution"> | ||
| <ul class="nav"> | ||
| <li> | ||
| <a href="https://github.com/launchdarkly/dotnet-core/blob/main/pkgs/sdk/server-ai/CHANGELOG.md/#L1" class="contribution-link">Edit this page</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> | ||
| <h5>In this article</h5> | ||
| <div></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer> | ||
| <div class="grad-bottom"></div> | ||
| <div class="footer"> | ||
| <div class="container"> | ||
| <span class="pull-right"> | ||
| <a href="#top">Back to top</a> | ||
| </span> | ||
|
|
||
| <span>Generated by <strong>DocFX</strong></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </div> | ||
|
|
||
| <script type="text/javascript" src="styles/docfx.vendor.min.js"></script> | ||
| <script type="text/javascript" src="styles/docfx.js"></script> | ||
| <script type="text/javascript" src="styles/main.js"></script> | ||
| </body> | ||
| </html> |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| <!DOCTYPE html> | ||
| <!--[if IE]><![endif]--> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
| <title>Contributing to the LaunchDarkly AI SDK (server-side) for .NET | LaunchDarkly Dotnet Server AI SDK </title> | ||
| <meta name="viewport" content="width=device-width"> | ||
| <meta name="title" content="Contributing to the LaunchDarkly AI SDK (server-side) for .NET | LaunchDarkly Dotnet Server AI SDK "> | ||
|
|
||
|
|
||
| <link rel="shortcut icon" href="favicon.ico"> | ||
| <link rel="stylesheet" href="styles/docfx.vendor.min.css"> | ||
| <link rel="stylesheet" href="styles/docfx.css"> | ||
| <link rel="stylesheet" href="styles/main.css"> | ||
| <meta property="docfx:navrel" content=""> | ||
| <meta property="docfx:tocrel" content=""> | ||
|
|
||
| <meta property="docfx:rel" content=""> | ||
|
|
||
| </head> | ||
| <body data-spy="scroll" data-target="#affix" data-offset="120"> | ||
| <div id="wrapper"> | ||
| <header> | ||
|
|
||
| <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> | ||
| <div class="container"> | ||
| <div class="navbar-header"> | ||
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> | ||
| <span class="sr-only">Toggle navigation</span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| </button> | ||
|
|
||
| <a class="navbar-brand" href="index.html"> | ||
| <img id="logo" class="svg" src="logo.svg" alt="LaunchDarkly Dotnet Server AI SDK"> | ||
| </a> | ||
| </div> | ||
| <div class="collapse navbar-collapse" id="navbar"> | ||
| <form class="navbar-form navbar-right" role="search" id="search"> | ||
| <div class="form-group"> | ||
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> | ||
| </div> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div class="subnav navbar navbar-default"> | ||
| <div class="container hide-when-search" id="breadcrumb"> | ||
| <ul class="breadcrumb"> | ||
| <li></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div class="container body-content"> | ||
|
|
||
| <div id="search-results"> | ||
| <div class="search-list">Search Results for <span></span></div> | ||
| <div class="sr-items"> | ||
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> | ||
| </div> | ||
| <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul> | ||
| </div> | ||
| </div> | ||
| <div role="main" class="container body-content hide-when-search"> | ||
| <div class="article row grid"> | ||
| <div class="col-md-10"> | ||
| <article class="content wrap" id="_content" data-uid=""> | ||
| <h1 id="contributing-to-the-launchdarkly-ai-sdk-server-side-for-net">Contributing to the LaunchDarkly AI SDK (server-side) for .NET</h1> | ||
|
|
||
| <p>LaunchDarkly has published an <a href="https://docs.launchdarkly.com/sdk/concepts/contributors-guide">SDK contributor's guide</a> that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.</p> | ||
| <h2 id="submitting-bug-reports-and-feature-requests">Submitting bug reports and feature requests</h2> | ||
| <p>The LaunchDarkly SDK team monitors the <a href="https://github.com/launchdarkly/dotnet-core/issues">issue tracker</a> in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.</p> | ||
| <h2 id="submitting-pull-requests">Submitting pull requests</h2> | ||
| <p>We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.</p> | ||
| <h2 id="build-instructions">Build instructions</h2> | ||
| <h3 id="prerequisites">Prerequisites</h3> | ||
| <p>To set up your SDK build time environment, you must <a href="https://dotnet.microsoft.com/download">download .NET development tools and follow the instructions</a>.</p> | ||
| <p>The AI SDK wraps the <a href="../server/index.md">Server-Side</a> SDK.</p> | ||
| <h3 id="building">Building</h3> | ||
| <p>To install all required packages:</p> | ||
| <pre><code class="lang-bash">dotnet restore | ||
| </code></pre> | ||
| <p>Then, to build the SDK for all target frameworks:</p> | ||
| <pre><code class="lang-bash">dotnet build src/LaunchDarkly.ServerSdk.Ai | ||
| </code></pre> | ||
| <p>Or, in Linux:</p> | ||
| <pre><code class="lang-bash">make | ||
| </code></pre> | ||
| <p>Or, to build for only one target framework (in this example, .NET Standard 2.0):</p> | ||
| <pre><code class="lang-bash">dotnet build src/LaunchDarkly.ServerSdk.Ai -f netstandard2.0 | ||
| </code></pre> | ||
| <h3 id="testing">Testing</h3> | ||
| <p>To run all unit tests:</p> | ||
| <pre><code class="lang-bash">dotnet test test/LaunchDarkly.ServerSdk.Ai.Tests/LaunchDarkly.ServerSdk.Ai.Tests.csproj | ||
| </code></pre> | ||
| <p>Or, in Linux:</p> | ||
| <pre><code class="lang-bash">make test | ||
| </code></pre> | ||
| <p>Note that the unit tests can only be run in Debug configuration. There is an <code>InternalsVisibleTo</code> directive that allows the test code to access internal members of the library, and assembly strong-naming in the Release configuration interferes with this.</p> | ||
| <h2 id="documentation-in-code">Documentation in code</h2> | ||
| <p>All public types, methods, and properties should have documentation comments in the standard C# XML comment format. These will be automatically included in the documentation that is generated on release; this process also uses additional Markdown content from the respective packages <code>docs-src/</code> subdirectory.</p> | ||
| <p>See <a href="docs-src/README.html"><code>docs-src/README.md</code></a> for more details.</p> | ||
|
|
||
| </article> | ||
| </div> | ||
|
|
||
| <div class="hidden-sm col-md-2" role="complementary"> | ||
| <div class="sideaffix"> | ||
| <div class="contribution"> | ||
| <ul class="nav"> | ||
| <li> | ||
| <a href="https://github.com/launchdarkly/dotnet-core/blob/main/pkgs/sdk/server-ai/CONTRIBUTING.md/#L1" class="contribution-link">Edit this page</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> | ||
| <h5>In this article</h5> | ||
| <div></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer> | ||
| <div class="grad-bottom"></div> | ||
| <div class="footer"> | ||
| <div class="container"> | ||
| <span class="pull-right"> | ||
| <a href="#top">Back to top</a> | ||
| </span> | ||
|
|
||
| <span>Generated by <strong>DocFX</strong></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </div> | ||
|
|
||
| <script type="text/javascript" src="styles/docfx.vendor.min.js"></script> | ||
| <script type="text/javascript" src="styles/docfx.js"></script> | ||
| <script type="text/javascript" src="styles/main.js"></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.