feat: compute mslearn symbol URL

dotnet · Mar 23, 2023 · 2cee4e3 · 2cee4e3
1 parent 9ff9823
commit 2cee4e3
Show file tree

Hide file tree

Showing 16 changed files with 185,565 additions and 16 deletions.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -26,9 +26,6 @@
         "exclude": [ "_site/**", "obj/**" ]
       }
     ],
-    "xrefService": [
-      "https://xref.docs.microsoft.com/query?uid={uid}"
-    ],
     "postProcessors": [ "ExtractSearchIndex" ],
     "globalMetadata": {
       "_appTitle": "docfx",

diff --git a/docs/tutorial/links_and_cross_references.md b/docs/tutorial/links_and_cross_references.md
@@ -238,6 +238,9 @@ Both will render to:
 
 Another common need is to reference topics from an external project. For example, when you're writing the documentation for your own .NET library, you'll want to add some links that point to types in .NET base class library. DocFX gives you two ways to achieve this functionality: by exporting all UIDs in a project into a map file to be imported in another project, and through cross reference services.
 
+> [!TIP]
+> Docfx automatically resolves .NET base class library types and other types published to <https://learn.microsoft.com> by default, without cross reference map or cross reference service. This process does not require network access.
+
 ### Cross reference map file
 
 When building a DocFX project, there will be an `xrefmap.yml` generated under output folder. This file contains information for all topics that have UID defined and their corresponding urls. The format of `xrefmap.yml` looks like this:
@@ -302,8 +305,6 @@ To use a cross reference service, add a `xrefservice` config to the `build` sect
 }
 ```
 
-For example, the URL for the cross reference service for .NET BCL types is `https://xref.docs.microsoft.com/query?uid={uid}`.
-
 ## Advanced: more options for cross reference
 
 You can create a cross link with following options:

diff --git a/samples/csharp/docfx.json b/samples/csharp/docfx.json
@@ -17,9 +17,6 @@
       }
     ],
     "dest": "_site",
-    "exportViewModel": true,
-    "xrefService": [
-      "https://xref.docs.microsoft.com/query?uid={uid}"
-    ]
+    "exportViewModel": true
   }
 }
diff --git a/samples/seed/docfx.json b/samples/seed/docfx.json
@@ -44,7 +44,6 @@
     },
     "dest": "_site",
     "exportViewModel": true,
-    "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ],
     "template": ["default", "modern"]
   },
   "pdf": {
@@ -70,7 +69,6 @@
       "filePath": "C:/Program Files/wkhtmltopdf/bin/wkhtmltopdf.exe",
       "additionalArguments": "--enable-local-file-access"
     },
-    "dest": "_site_pdf",
-    "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ]
+    "dest": "_site_pdf"
   }
 }
diff --git a/src/Microsoft.DocAsCode.Dotnet/Filters/ConfigFilterRule.cs b/src/Microsoft.DocAsCode.Dotnet/Filters/ConfigFilterRule.cs
@@ -71,7 +71,7 @@ public static ConfigFilterRule LoadWithDefaults(string filterConfigFile)
         ConfigFilterRule defaultRule, userRule;
 
         var assembly = Assembly.GetExecutingAssembly();
-        var defaultConfigPath = $"{assembly.GetName().Name}.Filters.defaultfilterconfig.yml";
+        var defaultConfigPath = $"{assembly.GetName().Name}.Resources.defaultfilterconfig.yml";
         using (var stream = assembly.GetManifestResourceStream(defaultConfigPath))
         {
             using var reader = new StreamReader(stream);

diff --git a/src/Microsoft.DocAsCode.Dotnet/Microsoft.DocAsCode.Dotnet.csproj b/src/Microsoft.DocAsCode.Dotnet/Microsoft.DocAsCode.Dotnet.csproj
@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
-    <EmbeddedResource Include="Transform\**" Exclude="bin\**;obj\**;**\*.xproj;packages\**;@(EmbeddedResource)" />
-    <EmbeddedResource Include="Filters\defaultfilterconfig.yml" Exclude="bin\**;obj\**;**\*.xproj;packages\**;@(EmbeddedResource)" />
+    <EmbeddedResource Include="Resources\**" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs
@@ -19,7 +19,7 @@ internal static class XmlCommentTransformer
     static XmlCommentTransformer()
     {
         var assembly = typeof(XmlCommentTransformer).Assembly;
-        var xsltFilePath = $"{assembly.GetName().Name}.Transform.XmlCommentTransform.xsl";
+        var xsltFilePath = $"{assembly.GetName().Name}.Resources.XmlCommentTransform.xsl";
         using var stream = assembly.GetManifestResourceStream(xsltFilePath);
         using var reader = XmlReader.Create(stream);
         var xsltSettings = new XsltSettings(true, true);