* [Docs] Get docs working on latest docfx version.
Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways.
Gotta figure out how to get the description generator and "last modified" plugins to work.
* [Docs] Get docs working on latest docfx version.
Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways.
Gotta figure out how to get the description generator and "last modified" plugins to work.
* [Docs] Re-add search index extractor.
* [Docs] Use material theme and override derived tree style.
Also adds a tiny GitHub icon on the navbar.
* [Docs] Exclude DebugTools project.
* [Docs] Use better method for overriding things.
Totally not because DocFX won't allow me to have an override template.
* [Docs] Improve styling overrides.
* [Docs] Fix links in FAQs and guides.
* [Docs] Use new xref service.
The old xref service is being deprecated by the end of the year.
See https://github.com/dotnet/docfx/issues/8958
* [Docs] Replace (c) with proper copyright symbol.
* [Docs] Fix formatting in docfx.json file.
Thanks, VSCode.
* [Docs] Remove non-working post processors.
They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either.
* [Docs] Fix "in this article" being too thin.
Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077
* [Docs] Get examples working again.
* [Docs] Make properties be separated more clearly.
* [Docs] Change docs index to reflect the new nightly MyGet feed.
* [Docs] Get docs working on latest docfx version.
Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways.
Gotta figure out how to get the description generator and "last modified" plugins to work.
* [Docs] Get docs working on latest docfx version.
Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways.
Gotta figure out how to get the description generator and "last modified" plugins to work.
* [Docs] Re-add search index extractor.
* [Docs] Use material theme and override derived tree style.
Also adds a tiny GitHub icon on the navbar.
* [Docs] Exclude DebugTools project.
* [Docs] Use better method for overriding things.
Totally not because DocFX won't allow me to have an override template.
* [Docs] Improve styling overrides.
* [Docs] Fix links in FAQs and guides.
* [Docs] Use new xref service.
The old xref service is being deprecated by the end of the year.
See https://github.com/dotnet/docfx/issues/8958
* [Docs] Replace (c) with proper copyright symbol.
* [Docs] Fix formatting in docfx.json file.
Thanks, VSCode.
* [Docs] Remove non-working post processors.
They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either.
* [Docs] Fix "in this article" being too thin.
Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077
* [Docs] Get examples working again.
* [Docs] Make properties be separated more clearly.
* [Docs] Change docs index to reflect the new nightly MyGet feed.
* [Docs] Fix index image not switching when changing themes.
Co-Authored-By: exsersewo <25526843+exsersewo@users.noreply.github.com>
* add updated description generator postprocessor
* update postprocessor
* got it working
* downgrade postprocessor docfx
* [Docs] Add left margin to side navigation links.
* remove dup docs cuz `<inheritdoc />`
---------
Co-authored-by: exsersewo <25526843+exsersewo@users.noreply.github.com>
Co-authored-by: Misha133 <mihagribkov133@gmail.com>
Co-authored-by: Mihail Gribkov <61027276+Misha-133@users.noreply.github.com>
* docs: adjust wording of ActivityType.Watching enum
Adjusts the xmldoc summary wording of the ActivityType.Watching enum to
fix a wording issue.
* Add D.NET Logo to Open Graph meta tags
* Update DescriptionGenerator
...And update color to suit the logo better
* Disable smooth scrolling due to user complaints
* Remove unnecessary spacing in sideaffix
* Update footer version
* Remove featherlight plugin
As it is unnecessary and can break image tags
* Adjust wordings regarding safe-handling of secrets
* Fix formatting for first bot token sample
* Add badges to homepage
* Minor wording fixes on terminal
* Update to higher quality PNG
* Add Discord.Net.Example in sln for build validation
* Clarify all instances of IAsnycEnumerable
* Clarify overridden props in SocketNewsChannel
* Add returns and params docs for SyncPermissionsAsync
* Remove/fix invalid XMLdoc strings
* Remove AppVeyor and add GitHub badge
* Fix broken link (#11)
* Fix typos and improve wording
* Add information for IGuildUser
+ Add GetPermission sample
+ Add ModifyAsync remarks
* Add information for IGuildChannel
+ Add ModifyAsync remarks
+ Add GetOverwritePermissionAsync examples
* Add warning for Direction.Around
* Fix indentations and references
* Move IRole.ModifyAsync sample
* Add information for IUser
+ Add example, remarks for Get(Default)AvatarUrl
+ Add example, remarks for GetOrCreateDMChannelAsync
+ Add missing remarks/summary/returns for other properties of the class
* Change verbs used in IVoiceState summary/remarks
* Add additional explanation for IGuildUser.RoleIds
* Change verbs used in IMessage summary/remarks
* Clarify IUserMessage Add/RemoveReactionAsync samples
* Fix command handler sample typo
* Add information for DiscordSocketConfig
+ Add remarks/example to the class
+ Add remarks to AlwaysDownloadUsers
* Fix documentation for SlowMode
* Add additional remarks for Guild/TextChannelProperties
* Update DocFx.Plugins.LastModified to v1.2.0
This should drastically improve docfx build time.
* Add missing dependencies
* Update DocFx.Plugins.LastModified to v1.2.1
Improve performance
* Update DocFx.Plugins.LastModified to v1.2.2
* Clarify deployment.md
+ Rewritten .NET Core deployment strategies for better clarification
* Split deployment types into framework-dependent and self-contained
* Clarify the benefits of using different types of publishing
* Include a sample of how to execute dotnet application with the dotnet command in a TIP dialog for visibility
* Update post-execution article and samples
+ This change is to reflect changes made in https://github.com/RogueException/Discord.Net/pull/1164, where CommandInfo is now passed into the CommandExecuted event as an Optional<T>
* Update DocFX.Plugin.DescriptionGenerator to v1.1.1
* Adjust according to recent CommandExecuted changes
See:
+ f549da50e0
+ 6260749095
* Add further documentation for https://github.com/RogueException/Discord.Net/pull/1037
* Add partial documentation for the precondition helper class
* Include CHANGELOG.md in docs
* Revise post-execution docs
* Fix incorrect Optional<T> usage
* Indent some sample code and add a comment reminding the user that the post-execution basic sample code is not ideal.
* Streamline docs for Attachment
+ This commit also adds further explanation for why Embeds and Attachments are read-only collections
* Add further documentation for MessageActivity and MessageApplication
* Add caching-related docs to ISocketMessageChannel
* Add missing documentation inheritance for SyncPermissionsAsync
* Streamline documentation process
This is done by changing the documentation of the implementations required by interfaces to redirect to the interface method instead (e.g., SocketDMChannel#GetMessagesAsync refer to IMessageChannel.GetMessagesAsync within the remarks of the method).
* Cleanup 92bf8363ca
* Update src/Discord.Net.Core/Entities/Channels/Direction.cs
Co-Authored-By: Still34 <341464@gmail.com>
* Update src/Discord.Net.Core/Entities/Channels/Direction.cs
Co-Authored-By: Still34 <341464@gmail.com>
* Update src/Discord.Net.Core/Entities/Channels/GuildChannelProperties.cs
Co-Authored-By: Still34 <341464@gmail.com>
* Update src/Discord.Net.WebSocket/DiscordSocketConfig.cs
Co-Authored-By: Still34 <341464@gmail.com>
* Update according to PR suggestions
* Reword sentences of deployment article for clarification & remove mention of portability
* Fix typos/grammar errors within TextChannelProperties
* Add the logo SVG to the page navbar
* Implement changing logo image based on theme color using CSS background image
* Add a favicon
* use the purple logomark instead of white
* hack? set the title to navbar svg to read "Discord.Net Docs"
this was done with intention to help keep the repository's working size
down, since most of these files will not be used.
rendered images have been moved online to
https://discord.foxbot.me/logo/
