add docs

Author: Vulthil

.config/dotnet-tools.json

@@ -8,6 +8,13 @@
         "reportgenerator"
       ],
       "rollForward": false
+    },
+    "docfx": {
+      "version": "2.78.5",
+      "commands": [
+        "docfx"
+      ],
+      "rollForward": false
     }
   }
 }

.github/copilot-instructions.md

@@ -1,4 +1,9 @@
 # Copilot Instructions
 
 ## Project Guidelines
-- Use a lazy `Target` pattern from `CreateInstance<T>` when inheriting from `BaseUnitTestCase` (or `BaseUnitTestCase<T>` when accessibility allows) for test classes in this repository.
+- Use a lazy `Target` pattern from `CreateInstance<T>` when inheriting from `BaseUnitTestCase` (or `BaseUnitTestCase<T>` when accessibility allows) for test classes in this repository.
+- When modifying a public member, make sure to update the XML Documentation and the corresponding docs in the docs folder and the README file if applicable.
+- Do not ignore CS1591 warnings; analyze and add missing XML comments instead.
+
+## Documentation Guidelines
+- When generating package README files, keep them short and concise, and use the docs folder for more elaborate usage patterns.

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Deploy DocFX to GitHub Pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+    paths:
+      - 'src/**'
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-dotnet@v5
+
+      - name: Install DocFX
+        run: dotnet tool restore
+
+      - name: Build documentation
+        run: dotnet tool run docfx docs/docfx.json
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -363,3 +363,6 @@ MigrationBackup/
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
 /tests/html-coverage-report
+
+# DocFX generated output
+docs/_site/

Directory.Build.props

@@ -3,9 +3,17 @@
 		<TargetFramework>net10.0</TargetFramework>
 		<Nullable>enable</Nullable>
 		<ImplicitUsings>enable</ImplicitUsings>
-		
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
+	<PropertyGroup Condition="'$(IsPackable)' != 'false' and Exists('README.md')">
+		<PackageReadmeFile>README.md</PackageReadmeFile>
+	</PropertyGroup>
+
+	<ItemGroup Condition="'$(IsPackable)' != 'false' and Exists('README.md')">
+		<None Include="README.md" Pack="true" PackagePath="\" />
+	</ItemGroup>
+
 	<PropertyGroup>
 		<Authors>Vulthil</Authors>
 		<RepositoryType>git</RepositoryType>

Vulthil.SharedKernel.slnx

@@ -3,6 +3,7 @@
     <File Path=".config/dotnet-tools.json" />
   </Folder>
   <Folder Name="/.github/">
+    <File Path=".github/copilot-instructions.md" />
     <File Path=".github/dependabot.yml" />
   </Folder>
   <Folder Name="/.github/instructions/">

docs/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+# Generated API metadata — rebuilt by DocFX on every run
+###############
+*.yml
+.manifest

docs/api/index.md

@@ -0,0 +1,3 @@
+# API Reference
+
+Browse the auto-generated API documentation for the **Vulthil.SharedKernel** libraries.

docs/articles/index.md

@@ -0,0 +1,3 @@
+# Articles
+
+Conceptual documentation and guides for **Vulthil.SharedKernel**.

docs/articles/toc.yml

@@ -0,0 +1,4 @@
+- name: Introduction
+  href: index.md
+- name: Packages
+  href: packages/