docs: added docs

.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  actions: 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:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+
+      - run: dotnet tool update -g docfx
+      - run: docfx ./docfx.json
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '/_site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -5,3 +5,5 @@ riderModule.iml
 /_ReSharper.Caches/
 /.idea
 /.vs
+/_site
+/.vs

DtoGenerator/DtoGenerator.csproj

@@ -28,7 +28,7 @@
     <NoPackageAnalysis>false</NoPackageAnalysis>
     <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);_AddAnalyzersToOutput</TargetsForTfmSpecificContentInPackage>
   </PropertyGroup>
-  
+
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
     <DocumentationFile>bin\Release\DtoGenerator.xml</DocumentationFile>
   </PropertyGroup>
@@ -40,7 +40,6 @@
     </PackageReference>
     <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.8.0" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
-    <None Include="..\readme.md" Pack="true" PackagePath="\" />
   </ItemGroup>
 
   <ItemGroup>
@@ -65,7 +64,7 @@
       <TfmSpecificPackageFile Include="$(OutputPath)\DtoGenerator.dll" PackagePath="analyzers/dotnet/cs" />
     </ItemGroup>
   </Target>
-  
+
   <Target Name="_AddAssembliesToOutput">
     <ItemGroup>
       <TfmSpecificPackageFile Include="$(OutputPath)\DtoGenerator.dll" PackagePath="lib/netstandard2.0/" />

README.md

@@ -2,10 +2,6 @@
 
 Stop writing boilerplate code for your DTOs. This package will generate them for you.
 
-# Introduction
-
-Since its generator library, and it works on compile time, it will not affect the performance of your application. It will generate the DTOs for you
-
 # Example
 
 ```csharp

api/.manifest

@@ -0,0 +1,19 @@
+{
+  "TenJames.DtoGenerator": "TenJames.DtoGenerator.yml",
+  "TenJames.DtoGenerator.DtoIgnoreAttribute": "TenJames.DtoGenerator.DtoIgnoreAttribute.yml",
+  "TenJames.DtoGenerator.DtoType": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.All": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.AllRead": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.Create": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.Read": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.ReadDetail": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoType.Update": "TenJames.DtoGenerator.DtoType.yml",
+  "TenJames.DtoGenerator.DtoVisibilityAttribute": "TenJames.DtoGenerator.DtoVisibilityAttribute.yml",
+  "TenJames.DtoGenerator.DtoVisibilityAttribute.#ctor(TenJames.DtoGenerator.DtoType)": "TenJames.DtoGenerator.DtoVisibilityAttribute.yml",
+  "TenJames.DtoGenerator.GenerateDtoAttribute": "TenJames.DtoGenerator.GenerateDtoAttribute.yml",
+  "TenJames.DtoGenerator.GenerateDtoAttribute.#ctor(TenJames.DtoGenerator.DtoType)": "TenJames.DtoGenerator.GenerateDtoAttribute.yml",
+  "TenJames.DtoGenerator.MapFromAttribute": "TenJames.DtoGenerator.MapFromAttribute.yml",
+  "TenJames.DtoGenerator.MapFromAttribute.#ctor(System.Type,System.String)": "TenJames.DtoGenerator.MapFromAttribute.yml",
+  "TenJames.DtoGenerator.MapToAttribute": "TenJames.DtoGenerator.MapToAttribute.yml",
+  "TenJames.DtoGenerator.MapToAttribute.#ctor(System.Type,System.String)": "TenJames.DtoGenerator.MapToAttribute.yml"
+}