docs: Added docs and releases.

.github/workflows/dotnet.yml

@@ -1,19 +1,38 @@
-name: Build, test and publish
+name: Publish
 on:
   push:
     branches:
       - main
     tags:
       - v**
 
+permissions:
+  contents: write
+
 jobs:
-  build-test-publish:
-    name: Build, test and publish
+  publish:
+    name: Publish
     uses: HavenDV/workflows/.github/workflows/dotnet_build-test-publish.yml@main
     with:
       generate-build-number: false
       conventional-commits-publish-conditions: false
       enable-caching: false
       additional-test-arguments: '--logger GitHubActions'
     secrets:
-      nuget-key: ${{ secrets.NUGET_KEY }}
+      nuget-key: ${{ secrets.NUGET_KEY }}
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: [publish]
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Create release
+        run: gh release create ${{ github.ref_name }}
+          --title "${{ github.ref_name }}"
+          --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/mkdocs.yml

@@ -0,0 +1,54 @@
+name: MKDocs Deploy
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'examples/**'
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install dependencies
+        run: pip install mkdocs-material
+
+      - name: Generate docs
+        run: dotnet run --project src/helpers/GenerateDocs/GenerateDocs.csproj .
+
+      - name: Build with MkDocs
+        run: mkdocs build -d ./_site
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pull-request.yml

@@ -1,12 +1,12 @@
-name: Build and test
+name: Test
 on:
   pull_request:
     branches:
       - main
 
 jobs:
-  build-test:
-    name: Build and test
+  test:
+    name: Test
     uses: HavenDV/workflows/.github/workflows/dotnet_build-test-publish.yml@main
     with:
       generate-build-number: false

DeepInfra.sln

@@ -33,6 +33,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TrimmingHelper", "src\helpe
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DeepInfra.IntegrationTests", "src\tests\DeepInfra.IntegrationTests\DeepInfra.IntegrationTests.csproj", "{A3F06E45-DFA8-4236-BFF5-425091762548}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GenerateDocs", "src\helpers\GenerateDocs\GenerateDocs.csproj", "{76B1F623-DFAE-4A87-BF5C-7A6E419443E6}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -55,6 +57,10 @@ Global
 		{A3F06E45-DFA8-4236-BFF5-425091762548}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A3F06E45-DFA8-4236-BFF5-425091762548}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{A3F06E45-DFA8-4236-BFF5-425091762548}.Release|Any CPU.Build.0 = Release|Any CPU
+		{76B1F623-DFAE-4A87-BF5C-7A6E419443E6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{76B1F623-DFAE-4A87-BF5C-7A6E419443E6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{76B1F623-DFAE-4A87-BF5C-7A6E419443E6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{76B1F623-DFAE-4A87-BF5C-7A6E419443E6}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -64,6 +70,7 @@ Global
 		{594DCFD8-E707-4232-B878-90FA3D880474} = {1A008ECD-2300-4BE4-A302-49DDF8BE0D54}
 		{9F7DC3A1-B113-4577-875D-73B2DDD6647A} = {1A008ECD-2300-4BE4-A302-49DDF8BE0D54}
 		{A3F06E45-DFA8-4236-BFF5-425091762548} = {AAA11B78-2764-4520-A97E-46AA7089A588}
+		{76B1F623-DFAE-4A87-BF5C-7A6E419443E6} = {1A008ECD-2300-4BE4-A302-49DDF8BE0D54}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {CED9A020-DBA5-4BE6-8096-75E528648EC1}

docs/css/extra.css

@@ -0,0 +1,102 @@
+/* Logo title */
+.md-header__topic:first-child {
+  font-weight: initial !important;
+}
+
+/* Code font size in <details> */
+details .linenos, details code {
+  font-size: inherit !important;
+}
+
+/* Code block / tab in details */
+details > summary + .highlight:last-child, details > summary + .tabbed-set:last-child { margin: 0 -0.6rem !important; }
+details > summary + .highlight:last-child > .highlighttable { margin: 0 !important; }
+
+/* Table full width */
+.md-typeset__table { display: block !important; }
+.md-typeset table:not(.highlighttable) { display: table !important; }
+
+.md-typeset table:not([class]) th {
+    min-width: 0rem;
+}
+
+.headerlink { transform: translateY(-2.5px); }
+
+.md-nav__link[for=__toc] .md-icon { margin-left: auto !important; }
+
+blockquote.page-time {
+  margin: 20px 0 !important;
+  border-left-color: #64b5f6 !important; /* Just change the color value and that's it*/
+}
+blockquote.page-copyright {
+  margin: 20px 0 !important;
+  border-left-color: #ff1700 !important; /* Just change the color value and that's it*/
+}
+blockquote.page-copyright i.md-icon {
+  display: inline-block;
+  margin-right: 5px;
+  transform: translateY(3.5px);
+  width: 18px;
+}
+
+#myBtn {
+    display: none;
+    position: fixed; 
+    bottom: 100px; 
+    right: 16px; 
+    z-index: 99; 
+    border: none;
+    outline: none; 
+    color: #8590a6;
+    cursor: pointer; 
+    padding: .7rem; 
+    border-radius: .4rem;
+}
+
+#myBtn:hover {
+    background-color: #d3d3d3; 
+}
+
+#color-button > button {
+  cursor: pointer;
+  transition: opacity .25s;
+  display: inline-block;
+  width: 6.5rem;
+  margin-bottom: 0.2rem;
+  padding: 1.2rem 0.4rem 0.2rem;
+  font-size: 0.64rem;
+  text-align: left;
+}
+
+#color-button > button[data-md-color-primary] {
+  background-color: var(--md-primary-fg-color);
+  color: var(--md-primary-bg-color);
+}
+#color-button > button[data-md-color-primary=white] {
+  box-shadow: inset 0 0 0.05rem rgb(0 0 0 / 54%);
+}
+
+#color-button > button[data-md-color-accent] {
+  background-color: var(--md-accent-fg-color);
+  color: var(--md-code-bg-color);
+}
+
+mjx-container > img {
+  width: 0;
+  height: 0;
+}
+
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color: #2e303e;
+  --md-accent-fg-color: #00bda4;
+  --md-typeset-a-color: #526cfe;
+}
+
+[data-md-color-scheme="slate"] .md-typeset img {
+  background: white;
+  filter: brightness(0.9);
+}
+
+[data-md-color-scheme="slate"] .md-typeset img[src$=".svg"] {
+  border: 4px solid white;
+}

mkdocs.yml

@@ -0,0 +1,108 @@
+site_name: OpenAI .NET Documentation
+nav:
+- Overview: index.md
+# EXAMPLES #
+
+#  - Quick Start: QuickStart.md
+#  - Architecture: Architecture.md
+#  - FAQ: FAQ.md
+#  - Contributing Guide: ContributingGuide.md
+#  - Tutorials:
+#      - Configure the native library loading: Tutorials/NativeLibraryConfig.md
+#      - Use executors: Tutorials/Executors.md
+#      - Use ChatSession: Tutorials/ChatSession.md
+#      - Understand LLamaContext: Tutorials/UnderstandLLamaContext.md
+#      - Get embeddings: Tutorials/GetEmbeddings.md
+#      - Quantize the model: Tutorials/Quantization.md
+#
+#  - Advanced Tutorials:
+#      - Customize the native library loading: AdvancedTutorials/CustomizeNativeLibraryLoading.md
+#
+#  - Integrations:
+#      - semantic-kernel integration: Integrations/semantic-kernel.md
+#      - kernel-memory integration: Integrations/kernel-memory.md
+#      - BotSharp integration: Integrations/BotSharp.md
+#      - Langchain integration: Integrations/Langchain.md
+#
+#  - Examples:
+#      - Bacthed executor - multi-output to one input: Examples/BatchedExecutorFork.md
+#      - Batched executor - basic guidance: Examples/BatchedExecutorGuidance.md
+#      - Batched executor - rewinding to an earlier state: Examples/BatchedExecutorRewind.md
+
+theme:
+  name: material
+  static_templates:
+    - 404.html
+  language: 'en'
+  palette:
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: white
+      accent: red
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/weather-night
+        name: Switch to light mode
+  include_search_page: false
+  search_index_only: true
+  favicon: 'media/icon128.png'
+  icon:
+    logo: 'material/file-document'
+  features:
+    - content.action.edit
+    - navigation.instant
+  font:
+    text: 'Fira Sans'
+    code: 'Fira Mono'
+
+extra:
+  version:
+    provider: mike
+
+extra_css:
+  - 'css/extra.css?v=14'
+
+markdown_extensions:
+  - admonition
+  - def_list
+  - footnotes
+  - meta
+  - toc:
+      permalink: ""
+      slugify: !!python/name:pymdownx.slugs.uslugify
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:pymdownx.emoji.to_svg
+  - pymdownx.highlight:
+      linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.progressbar
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: math
+          class: arithmatex
+          format: !!python/name:pymdownx.arithmatex.fence_mathjax_format
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+  - pymdownx.tabbed:
+      alternate_style: true

src/helpers/GenerateDocs/GenerateDocs.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+</Project>