lacking docs

[Ungolim]

docs are very lacking right now, for example i couldnt find any guide about sending complex embeds, reactions, etc.

can the devs do smth?

[Didas-git]

We acknowledge that the docs are rather weak right now and of course we plan on improving them as much as possible as we walk towards a 1.0 release.

As of right now sadly the "best" thing i can recommend is looking the the discord documentation, since we follow the naming on their documentation for our REST functions you can find how they can be used to some extend.

[Ungolim]

alright good, how much will current APIs break as you move towards 1.0?

btw, i found this project to be more useful than the REST API docs: https://github.com/YoruNoKen/HanamiBot/tree/main/src

[Didas-git]

There is only 1 breaking change right now and is related to the types as im working on organizing them better, soo while it is a breaking change it doesn't have any runtime impact. As for breaking changes with runtime impact we hope to not break anything but if we end up having to do it i can assure we will let the users know.

The REST documentation is auto generated and its lack luster because we do not have proper JSDoc comments in our code yet, this is something we will also be working on as we move towards 1.0.