search

hedwig-im / hedwig

An Adapter-based Bot Framework for Elixir Applications
MIT License
650 stars 73 forks source link

Making a tutorial / howto regarding adapters #63

Open ghost opened 7 years ago

ghost commented 7 years ago

As asked on Twitter, I'm opening this issue. This will also help me clarify what I mean by "a tutorial".

Although the API is quite small, perhaps the authors of the official adapters could write a document about the preferred architecture of an adapter and the best practices (OTP applications, helpful 3rd-party libraries, etc). ping @scrogson :)

bjufre commented 7 years ago

@ghost have you got anywhere with this? I was trying to find some kind of documentation about adapters so we can write our own and maybe contribute to the "adapters ecosystem" of Hedwig.

But so far no luck ;(

scrogson commented 7 years ago

This is definitely on my radar. But it may be something I will tackle for 2.0 as the Adapter API may change in the future.

At the moment, you could have a look at the Slack and XMPP adapters as examples.

The current adapter behaviour is very small but I agree it isn't documented properly.

bjufre commented 7 years ago

@scrogson Thanks for the quick response! I'll keep an eye for it then!!

And again thank you for the good work on Hedwig!

sntran commented 7 years ago

I'm in the process of writing an adapter for Hedwig. Should we use the Wiki for now to document the process? I can add notes as I go.

scrogson commented 7 years ago

@sntran feel free to create a wiki page.

fire commented 6 years ago

Debugging https://github.com/fire/hedwig_discord 's inability to reply to messages and was wondering if the logic for replying to responses is described anywhere?