https://github.com/dotnet/api-docs-sync
Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.
https://github.com/dotnet/api-docs-sync
documentation dotnet ecmaxml intellisense roslyn
Last synced: 4 months ago
JSON representation
Tools for porting documentation from intellisense xmls to api-docs, or from api-docs to triple slash comments.
- Host: GitHub
- URL: https://github.com/dotnet/api-docs-sync
- Owner: dotnet
- License: mit
- Created: 2019-06-26T17:40:39.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-21T20:49:04.000Z (9 months ago)
- Last Synced: 2025-01-30T07:42:32.804Z (4 months ago)
- Topics: documentation, dotnet, ecmaxml, intellisense, roslyn
- Language: C#
- Homepage:
- Size: 585 KB
- Stars: 10
- Watchers: 5
- Forks: 16
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# API Docs Sync
This repo contains two tools that allow porting documentation in two directions:
- IntelliSense xml files to MS Docs xml files. [Instructions](docs/PortToDocs.md).
- MS Docs xml files to triple slash comments in source code. [Instructions](docs/PortToTripleSlash.md).
## Requirements
- [.NET 8.0 SDK](https://get.dot.net/)
- A local git clone of a dotnet repo with source code whose APIs live in an API docs repo. Examples:
- [dotnet/runtime](https://github.com/dotnet/runtime)
- [dotnet/winforms](https://github.com/dotnet/winforms)
- [dotnet/wpf](https://github.com/dotnet/wpf)
- [dotnet/wcf](https://github.com/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](https://github.com/dotnet/dotnet-api-docs).
## 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