chore: adds support for docs generation and publishing via github act…

…ions

.github/actions/build-docs/action.yml

@@ -0,0 +1,13 @@
+# Use a step like this to build documentation.
+name: Build Documentation
+description: 'Build Documentation.'
+
+runs:
+  using: composite
+  steps:
+    - name: Build Documentation
+      shell: bash
+      run: |
+        dotnet tool update -g docfx
+        docfx metadata
+        docfx build

.github/actions/ci/action.yml

@@ -100,3 +100,8 @@ runs:
           # cat test-run.log | tr -s ' ' | cut -d ' ' -f 1,2,7-
           # if grep '\[FAIL\]' test-run.log >/dev/null; then exit 1; fi
 
+    # We build documentation during CI to ensure it can always build prior to a
+    # release.
+    - name: Build documentation
+      uses: ./.github/actions/build-docs
+

.github/actions/publish-docs/action.yml

@@ -0,0 +1,15 @@
+name: Publish Documentation
+description: 'Publish the documentation to Github pages'
+inputs:
+  token:
+    description: 'Token to use for publishing.'
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - uses: launchdarkly/gh-actions/actions/[email protected]
+      name: 'Publish to Github pages'
+      with:
+        docs_path: docs
+        github_token: ${{ inputs.token }} # For the shared action the token should be a GITHUB_TOKEN

.github/workflows/manual-publish-docs.yml

@@ -0,0 +1,21 @@
+on:
+  workflow_dispatch:
+
+name: Publish Docs
+jobs:
+  build-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Needed if using OIDC to get release secrets.
+      contents: write # Needed in this case to write github pages.
+    steps:
+      - uses: actions/checkout@v4
+      - id: build
+        name: Build and Test
+        uses: ./.github/actions/ci
+
+      - id: publish
+        name: Publish Documentation
+        uses: ./.github/actions/publish-docs
+        with:
+          token: ${{secrets.GITHUB_TOKEN}}

.github/workflows/publish.yml

@@ -48,13 +48,20 @@ jobs:
       - name: Build
         uses: ./.github/actions/build
 
-      - name: Retain artifacts for other jobs to use
+      - name: Retain build artifacts
         uses: actions/upload-artifact@v3
         with:
           name: dir-bin-release
           path: src/LaunchDarkly.ClientSdk/bin/Release/
           retention-days: 1
 
+      - name: Retain docs artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: dir-docs
+          path: docs/
+          retention-days: 1
+
 # Signing DLLs is done on Ubuntu due to Digicert tooling compatibility
   sign-dlls:
     runs-on: ubuntu-latest
@@ -107,6 +114,12 @@ jobs:
           name: dir-bin-release-signed
           path: src/LaunchDarkly.ClientSdk/bin/Release/
 
+      - name: Restore docs artifacts
+        uses: actions/download-artifact@v3
+        with:
+          name: dir-docs
+          path: docs/
+
       - uses: launchdarkly/gh-actions/actions/[email protected]
         name: Get secrets
         with:
@@ -124,3 +137,9 @@ jobs:
           name: unsigned-nupkg
           path: nupkgs/
           retention-days: 1
+
+      - uses: ./.github/actions/publish-docs
+        with:
+          # If publishing somewhere else, then get the token from SSM. If you need both github,
+          # and another token, then add more tokens to the composite action.
+          token: ${{secrets.GITHUB_TOKEN}}

docfx.json

@@ -0,0 +1,46 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "./src",
+          "files": [
+            "**/*.csproj",
+            "**/bin/**/**LaunchDarkly**.dll"
+          ]
+        }
+      ],
+      "dest": "./api",
+      "namespaceLayout": "nested"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "docs/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "docs",
+    "template": [
+      "default"
+    ],
+    "globalMetadata": {
+      "_appName": "LaunchDarkly Dotnet Client SDK",
+      "_appTitle": "LaunchDarkly Dotnet Client SDK",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

index.md

@@ -0,0 +1,11 @@
+---
+_layout: landing
+---
+
+# LaunchDarkly Client-Side SDK for .NET
+
+For first time users, visit our [LaunchDarkly Docs](https://docs.launchdarkly.com/sdk/client-side/dotnet) page.  Within these docs, the [LDClient](api/LaunchDarkly.Sdk.Client.LdClient.html) and the [ContextBuilder](api/LaunchDarkly.Sdk.ContextBuilder.html) are good starting points to explore from.
+
+This site contains the full API reference for the [`LaunchDarkly.ClientSdk`](https://www.nuget.org/packages/LaunchDarkly.ClientSdk) package, as well other packages used by the client package.
+
+For source code, see the [GitHub repository](https://github.com/launchdarkly/dotnet-client-sdk). The [developer notes](https://github.com/launchdarkly/dotnet-client-sdk/blob/main/CONTRIBUTING.md) there include links to other repositories used in the SDK.