chore: update docfx config and add unity xrefmap

docs/docfx.json

@@ -6,82 +6,30 @@
         {
           "src": "../src",
           "files": [
-            "R3.Unity/**.cs", // TODO: Needs UnityEngine/UnityEditor DLL references.
+            "R3.Unity/Assets/**.cs",
           ]
         }
       ],
-      "properties": {
-         "TargetFramework": "net8.0"
-      },
-      "dest": "api",
-      "allowCompilationErrors": true,
-      "outputFormat": "apiPage"
-    },
-    // Build API metadata from csproj (Except for projects that requires non .NET8 target framework)
-    {
-      "src": [
+      // TODO: Reference external DLLs
+      "references": [
         {
           "src": "../src",
           "files": [
-            "**/*.csproj"
-          ],
-          "exclude": [
-            "**/R3.WinForms.csproj",
-            "**/R3.WPF.csproj",
-            "**/R3.WinUI3.csproj"
-          ]         
-        }
-      ],
-      "properties": {
-         "TargetFramework": "net8.0"
-      },
-      "dest": "api",
-      "allowCompilationErrors": false,
-      "outputFormat": "apiPage"
-    },
-    // Build API metadata for WinForms/WPF projects.
-    {
-      "src": [
-        {
-          "src": "../src",
-          "files": [
-            "**/R3.csproj",
-            "**/R3.WinForms.csproj",
-            "**/R3.WPF.csproj",
-          ],
-          "exclude": [
-            "**/R3.WinUI3.csproj"
+            // "R3.dll",
+            // "UniTask.dll",
+            // "UnityEditor.dll",
+            // "UnityEngine.dll",
+            // "UnityEngine.UI.dll",
           ]
         }
       ],
       "properties": {
-         // TODO: 
-         // When TargetFramework is not specified. Following warning occurred. 
-         // > Project does not contain 'Compile' target.`
-         // But when specified. following warning occurred.
-         // > warning: [Warning] Found project reference without a matching metadata reference: C:\Projects\R3\src\R3\R3.csproj
-         "TargetFramework": "net8.0-windows" // When not specified. Following warning occurred. Project does not contain 'Compile' target.`
+         "DefineConstants": "UNITY_EDITOR;NET6_0_OR_GREATER;NET8_0_OR_GREATER;TOOLS", // TODO: Set minimum settings that are required for metadata generation.
+         "TargetFramework": "net8.0",                                                 // Note: TargetFramework is not used when building metadata from source files.
+         "ProduceReferenceAssembly": true                                             // Note: Required when csproj based build that target netstandard2.1
       },
       "dest": "api",
-      "allowCompilationErrors": false,
-      "outputFormat": "apiPage"
-    },
-    // Build API metadata for WinUI3 project.
-    {
-      "src": [
-        {
-          "src": "../src",
-          "files": [
-            "**/R3.csproj",
-            "**/R3.WinUI3.csproj",
-          ]
-        }
-      ],
-      "properties": {
-         //"TargetFramework": "net6.0-windows10.0.19041.0" // No need to specify target framework.
-      },
-      "dest": "api",
-      "allowCompilationErrors": false,
+      "allowCompilationErrors": true,
       "outputFormat": "apiPage"
     },
   ],
@@ -121,6 +69,9 @@
       "_noindex": true, // TODO: It's added to suppress contents crawled by search engine. It need to remove this settings for publish public site.
       "_enableSearch": true,
       "pdf": true
-    }
+    },
+    "xref": [
+      "xrefmaps/unity_2023.2.zip",
+    ]
   }
 }

docs/index.md

@@ -4,6 +4,9 @@ layout: landing
 
 # R3
 
+<xref:System.String>
+<xref:UnityEngine.GameObject>
+
 [![NuGet](https://img.shields.io/nuget/v/R3.svg)](https://www.nuget.org/packages/R3/)
 [![Downloads](https://img.shields.io/nuget/dt/R3.svg)](https://www.nuget.org/packages/R3/)
 [![Stars](https://img.shields.io/github/stars/Cysharp/R3?color=brightgreen)](https://github.com/Cysharp/R3/stargazers)