Discord.Net/docs/README.md
2024-06-13 17:43:59 +12:00

658 B

Instructions for Building Documentation

The documentation for the Discord.Net library uses DocFX. Instructions for installing this tool can be found here.

Important

You must use DocFX version 2.76.0 for everything to work correctly.

  1. Navigate to the root of the repository.
  2. Build the docs using docfx docs/docfx.json. Add the --serve parameter to preview the site locally.

Please note that if you intend to target a specific version, ensure that you have the correct version checked out.