dotnet / api-docs-sync

Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.

API Docs Sync

This repo contains two tools that allow porting documentation in two directions:

• IntelliSense xml files to MS Docs xml files. Instructions.

• MS Docs xml files to triple slash comments in source code. Instructions.

Requirements

• .NET 6.0 SDK
• A local git clone of a dotnet repo with source code whose APIs live in an API docs repo. Examples:
  • dotnet/runtime
  • dotnet/winforms
  • dotnet/wpf
  • dotnet/wcf
• A local git clone of the API docs repo where the above project hosts its documentation. For example, all the repos listed above host their documentation in the dotnet-api-docs repo.

Install as dotnet tools

To install the two tools as global dotnet tools in your $PATH, run the install-as-tool.ps1 script.

Documentation for global dotnet tools: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-install

Remember to update the tool periodically to collect the latest changes. Updating instructions: https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-tool-update