From 11495f2c2a00e3f790c40b2fab4a71647f486838 Mon Sep 17 00:00:00 2001 From: Hsu Still <341464@gmail.com> Date: Thu, 5 Apr 2018 18:41:28 +0800 Subject: [PATCH] Improve landing page & add intro --- docs/faq/getting-started.md | 33 +------------- .../{intro.md => first-bot.md} | 0 docs/guides/introduction/intro.md | 44 +++++++++++++++++++ docs/guides/toc.yml | 8 ++-- docs/index.md | 27 ++++++++---- 5 files changed, 67 insertions(+), 45 deletions(-) rename docs/guides/getting_started/{intro.md => first-bot.md} (100%) create mode 100644 docs/guides/introduction/intro.md diff --git a/docs/faq/getting-started.md b/docs/faq/getting-started.md index 1b1057bcf..eb6ff20c7 100644 --- a/docs/faq/getting-started.md +++ b/docs/faq/getting-started.md @@ -1,28 +1,5 @@ # Basic Concepts / Getting Started -## How do I get started? - -First of all, welcome! You may visit us on our Discord should you -have any questions. Before you delve into using the library, -however, you should have some decent understanding of the language -you are about to use. This library touches on -[Task-based Asynchronous Pattern] \(TAP), [polymorphism], [interface] -and many more advanced topics extensively. Please make sure that you -understand these topics to some extent before proceeding. - - Here are some examples: - 1. [Official quick start guide](https://github.com/RogueException/Discord.Net/blob/dev/docs/guides/getting_started/samples/intro/structure.cs) - 2. [Official template](https://github.com/foxbot/DiscordBotBase/tree/csharp/src/DiscordBot) - -> [!TIP] -> Please note that you should *not* try to blindly copy paste -> the code. The examples are meant to be a template or a guide. -> It is not meant to be something that will work out of the box. - -[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/ - ## How do I add my bot to my server/guild? You can do so by using the [permission calculator] provided @@ -73,12 +50,4 @@ Several common ways to do this: 2. Inspect the roles collection within the guild via your debugger. Please note that right-clicking on the role and copying the ID will -**not** work. It will only copy the message ID. - -## I have more questions! - -Please visit us at #dotnet_discord-net at [Discord API]. -Describe the problem in details to us, and preferably with the -problematic code uploaded onto [Hastebin](https://hastebin.com). - -[Discord API]: https://discord.gg/jkrBmQR \ No newline at end of file +**not** work. It will only copy the message ID. \ No newline at end of file diff --git a/docs/guides/getting_started/intro.md b/docs/guides/getting_started/first-bot.md similarity index 100% rename from docs/guides/getting_started/intro.md rename to docs/guides/getting_started/first-bot.md diff --git a/docs/guides/introduction/intro.md b/docs/guides/introduction/intro.md new file mode 100644 index 000000000..83620f100 --- /dev/null +++ b/docs/guides/introduction/intro.md @@ -0,0 +1,44 @@ +# Introduction + +## How do I get started? + +First of all, welcome! You may visit us on our Discord should you +have any questions. Before you delve into using the library, +however, you should have some decent understanding of the language +you are about to use. This library touches on +[Task-based Asynchronous Pattern] \(TAP), [polymorphism], [interface] +and many more advanced topics extensively. Please make sure that you +understand these topics to some extent before proceeding. + +Here are some examples: + +1. [Official quick start guide](https://github.com/RogueException/Discord.Net/blob/dev/docs/guides/getting_started/samples/intro/structure.cs) +2. [Official template](https://github.com/foxbot/DiscordBotBase/tree/csharp/src/DiscordBot) + +> [!TIP] +> Please note that you should *not* try to blindly copy paste +> the code. The examples are meant to be a template or a guide. +> It is not meant to be something that will work out of the box. + +[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/ + +## New to .NET/C#? + +If you are new to the language, using this lib may prove to be +difficult, but don't worry! There are many resources online that can +help you get started in the wonderful world of .NET. Here are some +resources to get you started. + +- [C# Programming Guide (MSDN/Microsoft, Free)](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/) +- [C# Fundamentals For Absolute Beginners (Channel9/Microsoft, Free)](https://channel9.msdn.com/Series/C-Fundamentals-for-Absolute-Beginners) +- [C# Path (Pluralsight, Paid)](https://www.pluralsight.com/paths/csharp) + +## 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 diff --git a/docs/guides/toc.yml b/docs/guides/toc.yml index 7e34a047b..1f3c06d70 100644 --- a/docs/guides/toc.yml +++ b/docs/guides/toc.yml @@ -1,9 +1,11 @@ +- name: Introduction + href: introduction/intro.md - name: Getting Started items: - name: Installation href: getting_started/installing.md - name: Your First Bot - href: getting_started/intro.md + href: getting_started/first-bot.md - name: Terminology href: getting_started/terminology.md - name: Basic Concepts @@ -23,6 +25,4 @@ - name: Post-execution Handling href: commands/post-execution.md - name: Voice - items: - - name: Voice Guide - href: voice/sending-voice.md + href: voice/sending-voice.md diff --git a/docs/index.md b/docs/index.md index ef9ecdfdd..22b15c5e2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,22 @@ - # Discord.Net Documentation -Discord.Net is an asynchronous, multiplatform .NET Library used to interface with the [Discord API](https://discordapp.com/). +## What is Discord.NET? + +Discord.NET is an asynchronous, multi-platform .NET Library used to +interface with the [Discord API](https://discordapp.com/). + +## Where to begin? + +If this is your first time using Discord.Net, you should refer to the +[Intro](guides/introduction/intro.md) for tutorials. +More experienced users might refer to the +[API Documentation](api/index.md) for a breakdown of the individuals +objects in the library. -If this is your first time using Discord.Net, you should refer to the [Intro](guides/getting_started/intro.md) for tutorials. -More experienced users might refer to the [API Documentation](api/index.md) for a breakdown of the individuals objects in the library. +## Additional Resources -For additional resources: - - [Discord API Guild](https://discord.gg/discord-api) - Look for `#dotnet_discord-net` - - [GitHub](https://github.com/RogueException/Discord.Net/tree/dev) - - [NuGet](https://www.nuget.org/packages/Discord.Net/) - - [MyGet Feed](https://www.myget.org/feed/Packages/discord-net) - Addons and nightly builds \ No newline at end of file +- [Discord API Guild](https://discord.gg/discord-api) - Look for `#dotnet_discord-net` +- [GitHub](https://github.com/RogueException/Discord.Net/) +- [NuGet](https://www.nuget.org/packages/Discord.Net/) +- [MyGet Feed](https://www.myget.org/feed/Packages/discord-net) - Add-ons and nightly builds +- [AppVeyor CI](https://ci.appveyor.com/project/RogueException/discord-net) - Nightly builds via Continuous Integration \ No newline at end of file