From 13938686ccd11c09081c1fcfe2e02b4c74038de9 Mon Sep 17 00:00:00 2001 From: Armano den Boef <68127614+Rozen4334@users.noreply.github.com> Date: Sat, 23 Oct 2021 17:33:07 +0200 Subject: [PATCH] Docs work (WIP) (#242) * Main page work * Metadata logo dir * More main page edits * Naming change * Dnet guide entries pruned --- docs/docfx.json | 4 +-- docs/guides/introduction/intro.md | 9 ++---- docs/guides/toc.yml | 43 +------------------------- docs/index.md | 50 +++++++++++++++++++++---------- 4 files changed, 41 insertions(+), 65 deletions(-) diff --git a/docs/docfx.json b/docs/docfx.json index 9179035fd..514b2a499 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -61,9 +61,9 @@ "overwrite": "_overwrites/**/**.md", "globalMetadata": { "_appTitle": "Discord.Net-Labs Documentation", - "_appFooter": "Discord.Net-Labs (c) 2020-2021 3.1.6", + "_appFooter": "Discord.Net-Labs (c) 2020-2021 3.1.7", "_enableSearch": true, - "_appLogoPath": "marketing/logo/SVG/Logomark Purple.svg", + "_appLogoPath": "marketing/logo/PackageLogo.png", "_appFaviconPath": "favicon.ico" }, "xrefService": ["https://xref.docs.microsoft.com/query?uid={uid}"] diff --git a/docs/guides/introduction/intro.md b/docs/guides/introduction/intro.md index 0a4ca26e9..1956fdae7 100644 --- a/docs/guides/introduction/intro.md +++ b/docs/guides/introduction/intro.md @@ -23,7 +23,7 @@ in [our GitHub repository]. > Please note that you should *not* try to blindly copy paste > the code. The examples are meant to be a template or a guide. -[our GitHub repository]: https://github.com/RogueException/Discord.Net/tree/dev/samples +[our GitHub repository]: https://github.com/Discord-Net-Labs/Discord.Net-Labs [Task-based Asynchronous Pattern]: https://docs.microsoft.com/en-us/dotnet/standard/asynchronous-programming-patterns/task-based-asynchronous-pattern-tap [polymorphism]: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/polymorphism [interface]: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/interfaces/ @@ -44,8 +44,5 @@ resources to get you started. ## Still have questions? -Please visit us at `#dotnet_discord-net` on the [Discord API] server. -Describe the problem in details to us, what you've done, and, -if any, the problematic code uploaded onto [Hastebin](https://hastebin.com). - -[Discord API]: https://discord.gg/jkrBmQR \ No newline at end of file +Please visit us at the [Labs Discord](https://discord.gg/dnet-labs) server. +Describe the problem in details to us, what you've tried and what you need help with. \ No newline at end of file diff --git a/docs/guides/toc.yml b/docs/guides/toc.yml index df2eb025a..603258c33 100644 --- a/docs/guides/toc.yml +++ b/docs/guides/toc.yml @@ -1,40 +1,5 @@ - name: Introduction topicUid: Guides.Introduction -- name: Getting Started - items: - - name: Installation - topicUid: Guides.GettingStarted.Installation - items: - - name: Nightly Builds - topicUid: Guides.GettingStarted.Installation.Nightlies - - name: Your First Bot - topicUid: Guides.GettingStarted.FirstBot - - name: Terminology - topicUid: Guides.GettingStarted.Terminology -- name: Basic Concepts - items: - - name: Logging Data - topicUid: Guides.Concepts.Logging - - name: Working with Events - topicUid: Guides.Concepts.Events - - name: Managing Connections - topicUid: Guides.Concepts.ManageConnections - - name: Entities - topicUid: Guides.Concepts.Entities -- name: Working with Commands - items: - - name: Introduction - topicUid: Guides.Commands.Intro - - name: TypeReaders - topicUid: Guides.Commands.TypeReaders - - name: Named Arguments - topicUid: Guides.Commands.NamedArguments - - name: Preconditions - topicUid: Guides.Commands.Preconditions - - name: Dependency Injection - topicUid: Guides.Commands.DI - - name: Post-execution Handling - topicUid: Guides.Commands.PostExecution - name: Working with Slash commands items: - name: Introduction @@ -51,7 +16,7 @@ topicUid: Guides.SlashCommands.SubCommand - name: Slash command choices topicUid: Guides.SlashCommands.Choices - - name: Slash ommands Bulk Overwrites + - name: Slash commands Bulk Overwrites topicUid: Guides.SlashCommands.BulkOverwrite - name: Working with Context commands items: @@ -71,9 +36,3 @@ topicUid: Guides.MessageComponents.SelectMenus - name: Advanced Concepts topicUid: Guides.MessageComponents.Advanced -- name: Emoji - topicUid: Guides.Emoji -- name: Voice - topicUid: Guides.Voice.SendingVoice -- name: Deployment - topicUid: Guides.Deployment diff --git a/docs/index.md b/docs/index.md index 063ec9e16..6934a9616 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,7 @@ uid: Root.Landing title: Home --- -# Discord.Net Labs Documentation +# Discord.NET Labs Documentation @@ -11,11 +11,11 @@ title: Home [![NuGet](https://img.shields.io/nuget/vpre/Discord.Net.Labs.svg?maxAge=2592000?style=plastic)](https://www.nuget.org/packages/Discord.Net.Labs/) [![MyGet](https://img.shields.io/myget/discord-net-labs/vpre/Discord.Net.Labs.svg)](https://www.myget.org/feed/Packages/discord-net-labs) [![Build Status](https://dev.azure.com/Discord-Net-Labs/Discord-Net-Labs/_apis/build/status/discord-net.Discord.Net?branchName=dev)](https://dev.azure.com/Discord-Net-Labs/Discord-Net-Labs/_build/latest?definitionId=1&branchName=release%2F3.x) -[![Discord](https://discord.com/api/guilds/848176216011046962/widget.png)](https://discord.gg/dvSfUTet3K) +[![Discord](https://discord.com/api/guilds/848176216011046962/widget.png)](https://discord.gg/dnet-labs) -## What is Discord.Net Labs? +## What is Discord.NET Labs? -Discord.Net Labs is an experimental fork of Discord.Net that implements the newest discord features for testing and development to eventually get merged into Discord.Net +Discord.NET Labs is an experimental fork of Discord.NET that implements the newest discord features for testing and development to eventually get merged into Discord.NET. Serving as a developer branch to the default project, it is a drop in replacement and can be used instead. It is ill advised to use Discord.NET Labs in a production environment normally. However if approached correctly, will work as an improved and up-to-date replacement to Discord.NET! ## Where to begin? @@ -25,23 +25,43 @@ If you are new to Discord.NET in general, you should refer their Is this your first time using Labs, but you are already familiar with Discord.NET? Refer to our [Guides](xref:Guides.Introduction) -### Slashcommands: +## Questions? -Examples on how slashcommands are created, handled & responded to is found -[Here](xref:Guides.SlashCommands.Intro) +Frequently asked questions are covered in the +[FAQ](https://discord-net-labs.com/FAQ.html). Read it thoroughly because most common questions are already answered there. -### User & Message commands: +If you still have unanswered questions after reading the FAQ, further support is available on +[Discord](https://discord.gg/dnet-labs). -Creating User & Message commands is found -[Here](xref:Guides.ContextCommands.Creating), -interacting with them is covered -[Here](xref:Guides.ContextCommands.Reveiving). +## Commonly used features -### Message components +#### Slash commands -Handling & creating message components such as buttons & dropdown menu's is found [Here](xref:Guides.MessageComponents.GettingStarted) +Slash commands are purposed to take over the normal prefixed commands in Discord and comes with good functionality to serve as a replacement. +Being interactions, they are handled as SocketInteractions. Creating and receiving slashcommands is covered below. + +- Find out more about slash commands in the +[Slash Command Guides](xref:Guides.SlashCommands.Intro) + +#### Message & User commands + +These commands can be pointed at messages and users, in custom application tabs. +Being interactions as well, they are able to be handled just like slash commands. They do not have options however. + +- Learn how to create and handle these commands in the +[Context Command Guides](xref:Guides.ContextCommands.Creating) + +#### Message components + +Components of a message such as buttons and dropdowns, which can be interacted with and responded to. +Message components can be set in rows and multiple can exist on a single message! + +- Explanation on how to add & respond to message components can be found in the +[Message Component Guides](xref:Guides.MessageComponents.GettingStarted) + +#### Note More experienced users might want to refer to the [API Documentation](xref:API.Docs) for a breakdown of the individual -objects in the library. +components in the library.