Elfayer / vue-land-bot

Official VueLand bot
5 stars 2 forks source link

Knowledgebase system/module #7

Open sustained opened 5 years ago

sustained commented 5 years ago

I dare not even count the amount of times I've seen someone take the time to craft a wonderful message, explaining how to solve some issue, or approach some problem. In some cases, these messages can end up being better than even the excellent official docs themselves!

Now imagine, what if we could:


And the use-cases are many.

For example, this is a very common exchange to see on the server:

<User A> Hello, I need help - here is an unformatted code dump.

<User B> My eyes!

<User C> :eyes:

<User D> Could you please format your code?

<User C> Yes, please.

<User A> How do I do that?

<User B> You can use backticks.

<User C> You do it like this:

```js // JavaScript goes here. ```

And you can change js to css, html etc. if you need to!


Now imagine the alternative:

<User A> Hello, I need help - here is an unformatted code dump.

<User B> !kb code-formatting @User A

(Bot sends User A a Direct Message explaining how to format code.

Imagine how much time, effort, bandwidth etc. we'll save!

I actually created such a system before for a bot on a server I used to admin at. It used Discord.js and Discord.js-Commando, even.

The data was stored in MongoDB (I regard it as a mistake).

If I was going to remake such a system, I would likely use Postgres and JSONB columns.

I'd be happy to undertake this feature.

sustained commented 5 years ago

Of course it is probably better to use this system for storing good/useful messages that contain actual knowledge and to keep the !kb code-formatting example as a separate command (e.g. !code, like in #1).

It was just an example of the versatility of such a system.

ZainW commented 5 years ago

If you keep the commands intuitive it would be easier to use and remember. whatever solution it comes to be the net result of thinking of the command , and writing it should be faster than someone trying to explain it

ie !cli brings up docs for vue cli where it explains everything about vue cli !code-help instructs people to show code and how to format it etc.

if you make it annoying for people to use people wont use it