Skip to content
This repository has been archived by the owner on Apr 20, 2022. It is now read-only.

Docs rework, prep for merge into DNET #359

Merged
merged 19 commits into from
Dec 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,165 @@
# Changelog

## [3.4.9] - 12/06/2021

### Fixed

- NRE when responding to an interaction with just an embed

## [3.4.8] - 12/04/2021

### Added

- Check for creating threads in news channels.
- Back netstandard2.0 and netstandard2.1 builds.
- IApplicationCommandInteraction interface and make IUserCommandInteraction, IMessageCommandInteraction, and ISlashCommandInteraction inherit it.
- FollowupWithFilesAsync to interactions to allow uploading multiple attachments.
- IUser User to IDiscordInteraction.

### Fixed

- NRE on modifying messages allowed mentions again.

### Misc

- Deprecate ApplicationCommandException in favor for HttpException.
- Made RespondAsync return a RestInteractionMessage based off of the parameters sent over to discord. This allows direct calls to ModifyAsync and DeleteAsync without having to get the interaction response first.
- Change Followup / Respond method signatures to move RequestOptions to the last parameter as well as change component to components.
- Update async summaries to contain information about the task in the return tag.

## [3.4.7] - 28/11/2021

### Added

- Methods for manually registering global comands.

### Fixed

- NRE on service providerless command execution.
- Wrong link in interactions framework docs.

## [3.4.6] - 27/11/2021

### Fixed

- Self user presence throwing upon set.

## [3.4.5] - 27/11/2021

### Fixed

- Another NRE with presence.

## [3.4.4] - 27/11/2021

### Fixed

- NRE with presence causing guild members to basically not exist.

## [3.4.3] - 27/11/2021

### Added

- PresenceUpdate socket event to help alleviate GuildMemberUpdate event calls.
- Guild.ClearUserCache(Predicate) to socket guilds.
- Warnings to the gateway client about intents, you can disable them by setting LogGatewayIntentWarnings to false in the discord socket config.
- DefaultApplications enum with the default games in the discord games lab.
- Support for sending multiple files on Webhooks.
- MaxBitrate to the IGuild interface.

### Fixed

- Bi-directional unicode names getting formatted wrong when calling IUser.ToString().
- CurrentUser with ICommandContext on DiscordShardedClient being null.
- NRE on Emote.TryParse.

## [3.4.2] - 26/11/2021

### Fixed

- Improve the GuildFeatures converter.
- Message/User commands are not being executed when their name have spaces on it.

## [3.4.1] - 26/11/2021

### Fixed

- SocketVoiceChannel options are created as generic mentionables in Interaction service

## [3.4.0] - 26/11/2021

### Added

- Interaction Service framework.

### Fixed

- NRE when modifying allowed mentions.

### Misc

- Updated summaries of interaction related classes.

## [3.3.3] - 11/23/2021

### Added

- Emoji to roles
- Invitable and Slowmode to thread creation
- Better discord errors.
- UseInteractionSnowflakeDate to config.

### Fixed

- Components not showing on FollowUpWithFile.
- Change the minimum length of slash commands to 1.
- Ratelimit timings.

### Misc

- Make RestUserCommand public.

## [3.3.2] - 11/21/2021

### Added

- GuildScheduledEventUserAdd and GuildScheduledEventUserRemove.
- New Cacheable<> type for rest based downloads while maintaining strong typed entities.

### Fixed

- Autocomplete not accepting values

## [3.3.1] - 11/21/2021

### Added

- ConfigureAwait(false) to async calls in rest based interactions.

### Fixed

- Slash commands will now have populated data.

## [3.3.0] - 11/19/2021

### Added

- Guild events.
- Rest-based http interactions.
- RTCRegion to voice channel properties.
- Support Min and Max values on ApplicationCommandOptions.
- Automatically fix ordering of optional command options.
- Interaction Specific Interfaces.

### Fixed

- Maximum number of Select Menu Options.

### Misc

- Changed default sticker behavior. You can configure getting default stickers on startup and auto resolve stickers with AlwaysDownloadDefaultStickers and AlwaysResolveStickers.
- Logomark, doc settings edit.

## [3.2.0] - 11/09/2021

### Added
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ any member of the community.

We prefer pull-requests that are descriptive of the changes being made
and highlight any potential benefits/drawbacks of the change, but these
types of write-ups are not required. See this [merge request](https://github.com/RogueException/Discord.Net/pull/793)
types of write-ups are not required. See this [merge request](https://github.com/discord-net/Discord.Net/pull/793)
for an example of a well-written description.

## Semantic Versioning
Expand All @@ -28,7 +28,7 @@ that are SemVer compliant with the latest version of the library in
development.

The working release should be the latest build off of the `dev` branch,
but can also be found on the [development board](https://github.com/RogueException/Discord.Net/projects/1).
but can also be found on the [development board](https://github.com/discord-net/Discord.Net/projects/1).

We follow the .NET Foundation's [Breaking Change Rules](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md)
when determining the SemVer compliance of a change.
Expand Down Expand Up @@ -59,4 +59,4 @@ The length of the documentation should also follow the ruler as suggested by our
#### Recommended Reads

* [Official Microsoft Documentation](https://docs.microsoft.com)
* [Sandcastle User Manual](https://ewsoftware.github.io/XMLCommentsGuide/html/4268757F-CE8D-4E6D-8502-4F7F2E22DDA3.htm)
* [Sandcastle User Manual](https://ewsoftware.github.io/XMLCommentsGuide/html/4268757F-CE8D-4E6D-8502-4F7F2E22DDA3.htm)
50 changes: 0 additions & 50 deletions FAQ.md

This file was deleted.

29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,32 +50,6 @@ Setting up labs in your project is really simple, here's how to do it:
2) Add Discord.Net Labs nuget to your project
3) That's all!

## Implementations
What Discord.NET-labs has that Discord.NET does not:

- Major changes
* Interaction Support.
* Application commands (slash, user, message).
* Message Components (buttons, select menus).
* Thread Channels.
* Stage Channels.
* Guild Events.
* Revamped Stickers.

- Minor changes
* Added `TimestampTag`.
* Made `Hierarchy` a `IGuildUser` property.
* Changes embed discription length to 4096.
* Added `Name` property to teams.
* Added url validation to embeds.
* Added `NsfwLevel` to Guilds.
* Added helpers to `Emoji` for parsing.
* Fixed gateway serialization to include nulls.
* Added banner and accent color to guild users.
* Fixed `CurrentUserId` in sharded clients being null.
* Fixed Guild owner and Admin `GuildPermissions.All`.
* Added `RatelimitCallback` to `RequestOptions`.

## Branches

### Dev
Expand All @@ -84,8 +58,5 @@ This branch is kept up to date with dnets dev branch. we pull of it to ensure th
### release/3.x
This branch is what will be pushed to nuget, sometimes its not up to date as we wait for other features to be finished.

### old/SlashCommandService
This branch is on pause and does not work currently, There is a pull request open to implement a working version of a slash command service. It can be found [here](https://github.com/Discord-Net-Labs/Discord.Net-Labs/pull/52)

### feature/xyz
These branches are features for new things, you are more than welcome to clone them and give feedback in the discord server or issues tab.
4 changes: 2 additions & 2 deletions docs/_overwrites/Commands/ICommandContext.Inclusion.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
An example of how this class is used the command system can be seen
below:

[!code[Sample module](../../guides/commands/samples/intro/empty-module.cs)]
[!code[Command handler](../../guides/commands/samples/intro/command_handler.cs)]
[!code[Sample module](../../guides/text_commands/samples/intro/empty-module.cs)]
[!code[Command handler](../../guides/text_commands/samples/intro/command_handler.cs)]
11 changes: 5 additions & 6 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,20 @@
"build": {
"content": [
{
"files": ["api/**.yml", "api/index.md"]
"files": [ "api/**.yml", "api/index.md" ]
},
{
"files": ["toc.yml", "index.md"]
"files": [ "toc.yml", "index.md" ]
},
{
"src": "../",
"files": ["FAQ.md"]
"files": [ "faq/**.md", "faq/**/toc.yml" ]
},
{
"files": ["guides/**.md", "guides/**/toc.yml"]
"files": [ "guides/**.md", "guides/**/toc.yml" ]
},
{
"src": "../",
"files": ["CHANGELOG.md"]
"files": [ "CHANGELOG.md" ]
}
],
"resource": [
Expand Down
Loading