diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 468ff7bd4..f19e7c297 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -10,6 +10,6 @@ I don't really have any strict conditions for writing documentation, but just ke ### Compiling -Documentation is compiled into a static site using [DocFx](dotnet.github.io/docfx/). You **must** install a version of DocFx that supports .NET Core. The latest build of that is [2.1.0-cli-alpha](https://github.com/dotnet/docfx/releases/tag/v2.1.0-cli-alpha). +Documentation is compiled into a static site using [DocFx](https://dotnet.github.io/docfx/). We currently use version 2.8 After making changes, compile your changes into the static site with `docfx`. You can also view your changes live with `docfx --serve`. \ No newline at end of file diff --git a/docs/guides/commands.md b/docs/guides/commands.md index 0ef259067..8c33527ea 100644 --- a/docs/guides/commands.md +++ b/docs/guides/commands.md @@ -139,7 +139,7 @@ To opt a module out of auto-loading, flag it with Invoke [CommandService.AddModulesAsync] to discover modules and install them. -[DontAutoLoadAttribute]: Discord.Commands.DontAutoLoadAttribute +[DontAutoLoadAttribute]: xref:Discord.Commands.DontAutoLoadAttribute [CommandService.AddModulesAsync]: xref:Discord_Commands_CommandService#AddModulesAsync_System_Reflection_Assembly_ #### Loading Modules Manually diff --git a/docs/guides/events.md b/docs/guides/events.md index 310b011e6..b10dc7648 100644 --- a/docs/guides/events.md +++ b/docs/guides/events.md @@ -17,7 +17,7 @@ To hook into events, you must be using the @Discord.WebSocket.DiscordSocketClien Connection Events will be raised when the Connection State of your client changes. -[DiscordSocketClient.Connected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Connected) and [Disconnected](Discord_WebSocket_DiscordSocketClient_Disconnected) are raised when the Gateway Socket connects or disconnects, respectively. +[DiscordSocketClient.Connected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Connected) and [Disconnected](xref:Discord.WebSocket.DiscordSocketClient#Discord_WebSocket_DiscordSocketClient_Disconnected) are raised when the Gateway Socket connects or disconnects, respectively. >[!WARNING] >You should not use DiscordClient.Connected to run code when your client first connects to Discord. The client has not received and parsed the READY event and guild stream yet, and will have an incomplete or empty cache.