daenamnu/discordeno
1
0
Fork 0
mirror of https://github.com/discordeno/discordeno.git synced 2026-06-02 08:50:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update GitHub repository link (#225)

Browse Source 
* Update FAQ links

* Update gettingstarted.md

* Update dockerhosting.md
This commit is contained in:
ITOH
2020-12-07 11:02:26 +01:00
committed by GitHub
parent e29f498fb4
commit 4888dc37da
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/advanced/dockerhosting.md
View File

@@ -2,11 +2,11 @@
Docker is an open platform for developing, shipping, and running applications. Docker enables you to separate your applications from your infrastructure so you can deliver software quickly. With Docker, you can manage your infrastructure in the same ways you manage your applications. By taking advantage of Docker’s methodologies for shipping, testing, and deploying code quickly, you can significantly reduce the delay between writing code and running it in production.
Learn more at https://docs.docker.com/get-started/
Learn more [here](https://docs.docker.com/get-started/)
### Installing Docker
Installing Docker is very simple and supported on nearly every major operating system! Just follow the instructions at https://docs.docker.com/get-docker/ to get started.
Installing Docker is very simple and supported on nearly every major operating system! Just follow the instructions [here](https://docs.docker.com/get-docker/) to get started.
### Building The Bot's Docker Image
@@ -40,4 +40,4 @@ docker stop CONTAINER_NAME
```bash
docker restart CONTAINER_NAME
```
```

12
docs/src/faq.md
View File

@@ -34,9 +34,9 @@ This means you never have to update your code EXCEPT when you are ready to bump
SemVer means more manual work for you to update code but a more secure module. Automated means almost no manual work for you to update code but a less secure module.
To understand that, SemVer makes it so you are using specific Release versions. In your code, you would do this by targeting the `..../Skillz4Killz/Discordeno/v4.0.0/...` in order to use it. Whenever I make a small bug fix or new feature that does not break your code it would be released in a new release such as today's release of v4.0.1. This means you have to manually update your code to get these latest improvements. Until you do, you may have bugs or possibly missing features. The good part about SemVer is that if I make a mistake that could potentially make the code worse, it's a lot easier to move back to a proper version with SemVer.
To understand that, SemVer makes it so you are using specific Release versions. In your code, you would do this by targeting the `..../discordeno/discordeno/v4.0.0/...` in order to use it. Whenever I make a small bug fix or new feature that does not break your code it would be released in a new release such as today's release of v4.0.1. This means you have to manually update your code to get these latest improvements. Until you do, you may have bugs or possibly missing features. The good part about SemVer is that if I make a mistake that could potentially make the code worse, it's a lot easier to move back to a proper version with SemVer.
The automated version would just simply be installed as soon as you reloaded cache for deno because it uses the branch itself as its url `.../Skillz4Killz/Discordeno/v4/...` For example, when i start bots I use a script that reloads cache and restarts the bot making it so i am always using the latest code. Deno makes this possible because it can pull the latest code from any URL even github. So using Github branches to it's peak I create a branch for each version. These versions simply update automatically and you dont have to worry about updating. The only time you need to update is when you bump a MAJOR version like from v4 to v5. Because these may need you to make changes in your code. Note, even the good part about SemVer can be slightly removed by just locking a certain commit as well using this method.
The automated version would just simply be installed as soon as you reloaded cache for deno because it uses the branch itself as its url `.../discordeno/discordeno/v4/...` For example, when i start bots I use a script that reloads cache and restarts the bot making it so i am always using the latest code. Deno makes this possible because it can pull the latest code from any URL even github. So using Github branches to it's peak I create a branch for each version. These versions simply update automatically and you dont have to worry about updating. The only time you need to update is when you bump a MAJOR version like from v4 to v5. Because these may need you to make changes in your code. Note, even the good part about SemVer can be slightly removed by just locking a certain commit as well using this method.
At the end of the day, I think both systems can work and I am curious how everyone feels about them. I will be trying my best to maintain both systems.
@@ -44,8 +44,8 @@ At the end of the day, I think both systems can work and I am curious how everyo
This is a design decision for the lib itself. You can still use class if you want on your bot. In fact, I hope someone makes a framework/boilerplate for this lib one day using classes so that devs have a choice on which style they prefer. Without trying to write an entire thesis statement on the reasons why I avoided Classes in this lib, I will just link to the best resources I believe help explain it.
- Really good article: https://dannyfritz.wordpress.com/2014/10/11/class-free-object-oriented-programming/
- Lecture by one of the developers who makes JavaScript: https://www.youtube.com/watch?v=PSGEjv3Tqo0
- [Really good article](https://dannyfritz.wordpress.com/2014/10/11/class-free-object-oriented-programming/)
- [Lecture by one of the developers who makes JavaScript](https://www.youtube.com/watch?v=PSGEjv3Tqo0)
In regards to EventEmitter, I believe a functional event API was a much better choice. EventEmitter at it's core is simply just functions that run when a certain event is emitted. In Discordeno, that function is executed instead of emitting some event to trigger that function.
@@ -80,8 +80,8 @@ Discordeno is the only library(that I have used), that has built in permission h
Discordeno provides you specific keywords that you can use to send a clean response to the end user of your choosing. I have even seen some bots have hundreds of thousands of Missing Permission or Missing Access errors because libraries don't handle it. IMO, this is a crucial part of any good library as much as it is to handle rate limiting.
```typescript
import { Errors } from "https://raw.githubusercontent.com/Skillz4Killz/Discordeno/v4/types/errors.ts";
import { Message } from "https://raw.githubusercontent.com/Skillz4Killz/Discordeno/v4/structures/message.ts";
import { Errors } from "https://raw.githubusercontent.com/discordeno/discordeno/v4/types/errors.ts";
import { Message } from "https://raw.githubusercontent.com/discordeno/discordeno/v4/structures/message.ts";
export function handleCommandError(message: Message, type: Errors) {
switch (type) {

2
docs/src/gettingstarted.md
View File

@@ -7,7 +7,7 @@ This website serves as the purpose for introducing Discordeno to developers. The
[View Documentation on Deno](https://doc.deno.land/https/deno.land/x/discordeno/mod.ts)
## Useful Links
- [GitHub Repository](https://github.com/Skillz4Killz/Discordeno)
- [GitHub Repository](https://github.com/discordeno/discordeno)
- [Deno Page](https://deno.land/x/discordeno)
- [Website](https://discordeno.mod.land)