Browse Source

Simplifying and elaborating installation docs

pull/2171/head
Armano den Boef 3 years ago
parent
commit
1d93ca1e2a
3 changed files with 19 additions and 36 deletions
  1. +19
    -3
      docs/guides/getting_started/installing.md
  2. +0
    -30
      docs/guides/getting_started/labs.md
  3. +0
    -3
      docs/guides/toc.yml

+ 19
- 3
docs/guides/getting_started/installing.md View File

@@ -35,9 +35,25 @@ other limitations, you may also consider targeting [.NET Framework]
Release builds of Discord.Net will be published to the
[official NuGet feed].

Development builds of Discord.Net, as well as add-ons, will be
published to our [MyGet feed]. See
@Guides.GettingStarted.Installation.Nightlies to learn more.
### Pre-releases

Nuget also includes pre-releases for all minor & major versions,
from which patches will be pushed until the version is ready for a stable release.
Pre-releases introduce the latest features, and receives common updates towards bug fixes where required.
Old features breaking down in new pre-releases is uncommon, so using pre-releases to test new features is not ill-adviced.

### Experimental/Development

Development builds of Discord.Net will be
published to our [MyGet feed]. The MyGet feed can be used to run the latest dev branch builds.
It is not adviced to use MyGet packages in a production environment, as changes may be made that negatively affect certain library functions.
If you want to test out new features before they've been officially released, you should use the pre-releases instead.

### Labs

This exterior branch of Discord.Net has been deprecated and is no longer supported.
If you have used Discord.Net-Labs in the past, you are adviced to update to the latest version of Discord.Net.
All features in Labs are implemented in the main repository.

[official nuget feed]: https://nuget.org
[myget feed]: https://www.myget.org/feed/Packages/discord-net


+ 0
- 30
docs/guides/getting_started/labs.md View File

@@ -1,30 +0,0 @@
---
uid: Guides.GettingStarted.Installation.Labs
title: Installing Labs builds
---

# Installing Discord.NET Labs

Discord.NET Labs is the experimental repository that introduces new features & chips away at all bugs until ready for merging into Discord.NET.
Are you looking to test or play with new features?

> [!IMPORTANT]
> It is very ill advised to use Discord.NET Labs in a production environment normally,
> considering it can include bugs that have not been discovered yet, as features are freshly added.
> However if approached correctly, will work as a pre-release to Discord.NET.
> Make sure to report any bugs at the Labs [repository] or on [Discord]

[Discord]: https://discord.gg/dnet
[repository]: https://github.com/Discord-Net-Labs/Discord.Net-Labs

## Installation:

[NuGet] - This only includes releases, on which features are ready to test.

> [!NOTE]
> Installing NuGet packages is covered fully at [Installing Discord NET](xref:Guides.GettingStarted.Installation)

[MyGet] - Available for current builds and unreleased features.

[NuGet]: https://www.nuget.org/packages/Discord.Net.Labs/
[MyGet]: https://www.myget.org/feed/Packages/discord-net-labs

+ 0
- 3
docs/guides/toc.yml View File

@@ -6,9 +6,6 @@
items:
- name: Installation
topicUid: Guides.GettingStarted.Installation
items:
- name: Nightly builds
topicUid: Guides.GettingStarted.Installation.Labs
- name: Your First Bot
topicUid: Guides.GettingStarted.FirstBot
- name: Terminology


Loading…
Cancel
Save