Proper Documentation to dimscord library

krisppurg / dimscord

A Discord Bot & REST Library for Nim.

https://krisppurg.github.io/dimscord/

MIT License

222 stars 22 forks source link

Proper Documentation to dimscord library #65

Open Justaus3r opened 2 years ago

Justaus3r commented 2 years ago

Hello,Firstly a huge thanks for writing such a wonderful discord module for nim. Secondly as the title suggests .a proper beginners documentation would be helpful to anyone who wants to use the library.there is a documentation at https://krisppurg.github.io/dimscord/dimscord.html but it isnt very beginners friendly.

krisppurg commented 2 years ago

Hm, what parts of the documentation are not beginner friendly? There is also a Dimscord Wiki, but I think I might as well update that.

Justaus3r commented 2 years ago

Thanks for the quick reply.what i mean is ,i also started programming in nim not too long ago ,from what i see this module is also a asynchronous module like pythons discord.py.i think you should start with a installation part ,followed by a quickstart part and then you can explain all the procedures afterwards .or maybe it might be me being used to reading python style rst format docs.also it would be a huge help if you could compare it to pythons discord.py module,i mean a minimal example for both programming language to help python programmers start with this module.

regards,

krisppurg commented 2 years ago

Well, there is an installation guide in the README. The procedures one is self explanatory. So: For restapi:

api Of course is the RestApi object. In which can be found on discord.api
Some parameters have none ... in them, so: none ChannelType, is basically just Option[ChannelType], except it defaults to be none so it wouldn't force you to provide.
reason is audit log reason 0..512 characters.
As you may notice some procedures have comments, these are usually for notes and additional information.

For gateway:

Again contains comments for additional information.

For objects:

The only thing you might find is probably the Events objects, which I might actually provide more information on
- Each field in Events, is just basically
```
proc events_field_name(params...) {.event(discord).} =
discard # by default
```

Justaus3r commented 2 years ago

i see,greatly appreciated !

xytrux commented 3 weeks ago

So is there going to be new docs?

krisppurg commented 1 week ago

So is there going to be new docs?

hmm, I wouldn't rewrite documentation but I would prefer to make some adjustments and clarifications on some certain methods and procedures (e.g. restapi methods). I could make a document or some special page to help guide and provide some other extra info along with some FAQs, that way it's a lot more easier. I'll give it some thought for the time being.