driver-telegram icon indicating copy to clipboard operation
driver-telegram copied to clipboard

TODO: Improve documentation

Open feralheart opened this issue 5 years ago • 4 comments

In this issue I will collect everything what should be included into the documentation.

If you have suggestions send a comment to this issue.

Bot replies to a message: #62

feralheart avatar Jun 08 '20 08:06 feralheart

Edit: I'm just recognizing that your question is directed to the telegram-driver and not how the general documentation could be improved. Most of my topics below are meant in general. But the first one with "inline keyboards" would be interesting for specifically Telegram. Ignore the rest if not helpful.

Thanks for creating this issue :) Some topics I've got in mind:

  • Inline Keyboards - a lot people struggle with this, I think some simple examples would be helpful
  • How to deal with Cache & Cache-Expiration - I think for most people the current information is sufficient, but especially with systems with longer on-going conversations/conversation loops over longer time-periods (in which the cache must be cleaned for example to deploy a new version), some best practices would be nice :)
  • Emoji - Chatbot conversations contain by their nature most probably some emojis. It would be nice to know a little bit more about how to handle them in a good way.
  • Multilanguage - A multi-language setup is highly realistic in many scenarios. Laravel's default translation approach isn't working very well (at least based on my limited know-how) with translation-management software (like POEditor.com). Because of this, it would be great to know also in this topic some best-practices on how to handle this in the best possible way.
  • Compatibility - Is Botman (studio) really compatible in every direction to the latest stable Releases of Laravel? Some clarifications would be nice.
  • Cross-Chanel Usage - Based on my knowledge and beside enterprise approaches, Botman is independent of any programming language a unique self-hosted solution that can handle that many messengers. It could be useful in some cases to have cross-messenger communication ability (like starting the communication on FB, continuing on Telegram..). Again Best-Practices would be helpful (also for keeping a history of all channels in the web-widget).
  • Account-Management: Messengers provide a unique ID, but whats about connecting such an ID to a central account that is used for some non-bot interactions (like a control panel in a web-browser). Again Best-Practices would be helpful.

If there are clarifications needed, please let me know :)

blankster avatar Jul 01 '20 19:07 blankster

Thank you @blankster for your comment, these are very good topics :)

feralheart avatar Jul 12 '20 14:07 feralheart

Hi, not sure if this is right place to ask, but is this package maintained really? I see a bunch of useful pull requests including 2 of mine, but they don't seem to be reviewed by the maintainer. But there are more and more improvements I personally do in this package using it in my projects. So I'm forced to use my own fork. For example I'm developing a lot with Inline Mode and for now this package doesn't support it at all.

What does botman community thinks of this problem?

vdomah avatar Jul 18 '20 12:07 vdomah

@vdomah I'm also not sure if this is the right place for such a discussion but share your feelings and situation. In general, I think Botman is very unique and powerful and it's a pity that there isn't more active development. Also when I look at https://botman.io/forum/d/8-botman-3-0-feature-wishlist, I'm not sure if this version 3 will be ever released. I've tried in private to get into a conversation with the maintainer (Marcel) but wasn't successful getting a reply.

But I also totally understand that he has a lot of other ideas/obligations/projects/priorities as it seems (I personally think that's the reason) and appreciate everything Botman already does and I'm thankful for all the efforts involved people provided. He doesn't own us anything and Botman is a free and open-source solution, we've luckily the option to fork it and improve it as we want. We (with our project) are not at the stage that we can contribute back, but good quality given, I personally think at least good pull-requests should be merged into the project. In general, I try not to expect anything and am happy about everything good that happens.

I would love to talk about Botman development with you if you want, maybe this would be an interesting conversation. Feel free to hit me on Telegram by http://t.me/blankster.

blankster avatar Jul 18 '20 21:07 blankster