From 747e1030dd9dfe2562a4543cb2a04aa2455eb8bd Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Tue, 13 Jun 2023 13:35:29 +0800 Subject: [PATCH] docs: add DotnetApiCatalog.GenerateManagedReferenceYamlFiles #8866 --- docs/docs/dotnet-api-docs.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/dotnet-api-docs.md b/docs/docs/dotnet-api-docs.md index 27938525fd6..03234eee504 100644 --- a/docs/docs/dotnet-api-docs.md +++ b/docs/docs/dotnet-api-docs.md @@ -26,6 +26,10 @@ To add API docs for a .NET project, add a `metadata` section before the `build` Docfx generates .NET API docs in 2 stages: 1. The _metadata_ stage uses the `metadata` config to produce [.NET API YAML files](dotnet-yaml-format.md) at the `metadata.dest` directory. +> [!NOTE] +> The [`Docset.Build`](../api/Microsoft.DocAsCode.Docset.yml) method does not run the _metadata_ stage, +> invoke the [`DotnetApiCatalog.GenerateManagedReferenceYamlFiles`](../api/Microsoft.DocAsCode.Dotnet.DotnetApiCatalog.yml) method to run the _metadata_ stage before the _build_ stage. + 2. The _build_ stage transforms the generated .NET API YAML files specified in `build.content` config into HTML files. These 2 stages can run independently with the `docfx metadata` command and the `docfx build` command. The `docfx` root command runs both `metadata` and `build`.