Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Telegram payments guide #155

Open
15 tasks
KnorpelSenf opened this issue Dec 13, 2021 · 12 comments
Open
15 tasks

feat: Telegram payments guide #155

KnorpelSenf opened this issue Dec 13, 2021 · 12 comments
Assignees

Comments

@KnorpelSenf
Copy link
Member

KnorpelSenf commented Dec 13, 2021

  1. Introduction
  • Provide a brief overview of the purpose of the Payments Guide.
  • Explain the importance of understanding payment integration for bot development on the platform.
  1. Feature Overview
  • Describe the functionality of the payment feature in bot development, highlighting its benefits and potential use cases.
  • Include a link to the official Telegram documentation for accepting payments from users.
  1. Understanding Payments on Telegram
  • Explain how payments on Telegram work, emphasizing that Telegram doesn't handle the money itself.
  • Outline the general setup process and the involvement of payment providers.
  • Describe the flow of data between Telegram, payment providers, and the bot.
  • Explain the flow of money from users to the bot developer's account.
  1. Prerequisites
  • List the requirements and prerequisites for getting started with accepting payments on Telegram.
  • Mention if a credit card is needed, any specific accounts that need to be set up, or any tokens/secrets required for integration.
  1. Integration Steps with grammY
  • Provide step-by-step instructions on how to code the payment integration using the grammY framework.
  • Include example code snippets for each relevant step, demonstrating how to set up and handle payments within a bot.
  1. Advanced Topics and Tips
  • Offer additional tips, tricks, and best practices for working with payments on Telegram.
  • Include information on advanced settings and customization options for payment integration.
  • Provide links to other relevant resources, such as official Telegram documentation or community forums for further exploration.
@LWJerri
Copy link
Collaborator

LWJerri commented Mar 22, 2023

@KnorpelSenf, that's all good, but I'd like to know what exactly do we need to write? Any steps on how to set up payment or anything like that? It would be nice to create a small base of questions or topics that need to be covered.

@KnorpelSenf
Copy link
Member Author

KnorpelSenf commented Mar 22, 2023

My typical approach to writing these pages is:

  1. What does this feature do? (Bot dev accept payments from users, link to TG docs)
  2. How do payments on TG work? (TG doesn't handle the money itself, so how is this set up? Payment providers? What's the flow of data? What's the flow of money?)
  3. What do I need to get started? (Credit card? Any accounts? Any tokens/secrets?)
  4. How can this be coded with grammY? (Example code snippets for each relevant step in 2.)
  5. Useful tips, advanced settings, links to other resources, how to move on from here, anything else?

LMK if this is detailed enough for you to get started. We can also ask other people for their opinions if this isn't useful. :)

@rojvv rojvv changed the title feat: Add article about payments feat: Payments guide Mar 22, 2023
@LWJerri
Copy link
Collaborator

LWJerri commented Apr 11, 2023

Okay, then I will prepare some information base and try to write something.

@KnorpelSenf
Copy link
Member Author

Feel free to share early drafts so we can iterate on the changes together :)

@LWJerri
Copy link
Collaborator

LWJerri commented May 26, 2023

Feel free to share early drafts so we can iterate on the changes together :)

Hi. I have some references on how to do these docs, but currently, study year is an outing and I have exams, etc.

@LWJerri LWJerri linked a pull request Jun 10, 2023 that will close this issue
@LWJerri
Copy link
Collaborator

LWJerri commented Jun 19, 2023

Soooo, this is my structure for the Telegram payments guide. @KnorpelSenf, what do you think about it?

  1. Introduction
  • Provide a brief overview of the purpose of the Payments Guide.
  • Explain the importance of understanding payment integration for bot development on the platform.
  1. Feature Overview
  • Describe the functionality of the payment feature in bot development, highlighting its benefits and potential use cases.
  • Include a link to the official Telegram documentation for accepting payments from users.
  1. Understanding Payments on Telegram
  • Explain how payments on Telegram work, emphasizing that Telegram doesn't handle the money itself.
  • Outline the general setup process and the involvement of payment providers.
  • Describe the flow of data between Telegram, payment providers, and the bot.
  • Explain the flow of money from users to the bot developer's account.
  1. Prerequisites
  • List the requirements and prerequisites for getting started with accepting payments on Telegram.
  • Mention if a credit card is needed, any specific accounts that need to be set up, or any tokens/secrets required for integration.
  1. Integration Steps with grammY
  • Provide step-by-step instructions on how to code the payment integration using the grammY framework.
  • Include example code snippets for each relevant step, demonstrating how to set up and handle payments within a bot.
  1. Advanced Topics and Tips
  • Offer additional tips, tricks, and best practices for working with payments on Telegram.
  • Include information on advanced settings and customization options for payment integration.
  • Provide links to other relevant resources, such as official Telegram documentation or community forums for further exploration.
  1. Conclusion and Next Steps
  • Summarize the key points covered in the Payments Guide.
  • Encourage users to explore the provided information and experiment with payment integration.
  • Suggest possible next steps or related topics for further learning.
  1. Review and Feedback
  • Invite users to provide feedback on the documentation, ensuring clarity and completeness.
  • Consider involving other individuals or stakeholders to review and offer their opinions on the guide.

If that's okay, I'll convert this message to ToDo and start my work.

@KnorpelSenf
Copy link
Member Author

  1. Introduction
  • Provide a brief overview of the purpose of the Payments Guide.

There is no need to say why a guide a necessary. When people open a guide for payments, they already have a reason to read it. What you can do is to include an introducing sentence about the purpose of payments themselves.

  • Explain the importance of understanding payment integration for bot development on the platform.

Yeap, but don't drag this out. Again, users who read this have a reason already.

  1. Feature Overview
  • Describe the functionality of the payment feature in bot development, highlighting its benefits and potential use cases.
  • Include a link to the official Telegram documentation for accepting payments from users.

Great. Also consider including limitations. It's good to have a differentiated view, not advertise the feature too much (just a little).

  1. Understanding Payments on Telegram
  • Explain how payments on Telegram work, emphasizing that Telegram doesn't handle the money itself.
  • Outline the general setup process and the involvement of payment providers.
  • Describe the flow of data between Telegram, payment providers, and the bot.
  • Explain the flow of money from users to the bot developer's account.
  1. Prerequisites
  • List the requirements and prerequisites for getting started with accepting payments on Telegram.
  • Mention if a credit card is needed, any specific accounts that need to be set up, or any tokens/secrets required for integration.

Awesome

  1. Integration Steps with grammY
  • Provide step-by-step instructions on how to code the payment integration using the grammY framework.
  • Include example code snippets for each relevant step, demonstrating how to set up and handle payments within a bot.

Nice. I usually expect readers to stop reading here because their bot works now.

  1. Advanced Topics and Tips
  • Offer additional tips, tricks, and best practices for working with payments on Telegram.
  • Include information on advanced settings and customization options for payment integration.
  • Provide links to other relevant resources, such as official Telegram documentation or community forums for further exploration.

Great to include this, I'm curious what you'll link here.

  1. Conclusion and Next Steps
  • Summarize the key points covered in the Payments Guide.
  • Encourage users to explore the provided information and experiment with payment integration.
  • Suggest possible next steps or related topics for further learning.

Drop the summary. If we feel like we need a summary then the page isn't concise enough. Next steps are cool, but they can also be included along the way (“if you want to know more about this step, look here”) rather than at the end of the page.

  1. Review and Feedback
  • Invite users to provide feedback on the documentation, ensuring clarity and completeness.
  • Consider involving other individuals or stakeholders to review and offer their opinions on the guide.

This sounds like ChatGPT generated it. Sounds pointless to me. It isn't related to payments in any way and we already have this content written down elsewhere. What are the stakeholders even?

@LWJerri
Copy link
Collaborator

LWJerri commented Jun 19, 2023

  1. Introduction
  • Provide a brief overview of the purpose of the Payments Guide.

There is no need to say why a guide a necessary. When people open a guide for payments, they already have a reason to read it. What you can do is to include an introducing sentence about the purpose of payments themselves.

  • Explain the importance of understanding payment integration for bot development on the platform.

Yeap, but don't drag this out. Again, users who read this have a reason already.

  1. Feature Overview
  • Describe the functionality of the payment feature in bot development, highlighting its benefits and potential use cases.
  • Include a link to the official Telegram documentation for accepting payments from users.

Great. Also consider including limitations. It's good to have a differentiated view, not advertise the feature too much (just a little).

  1. Understanding Payments on Telegram
  • Explain how payments on Telegram work, emphasizing that Telegram doesn't handle the money itself.
  • Outline the general setup process and the involvement of payment providers.
  • Describe the flow of data between Telegram, payment providers, and the bot.
  • Explain the flow of money from users to the bot developer's account.
  1. Prerequisites
  • List the requirements and prerequisites for getting started with accepting payments on Telegram.
  • Mention if a credit card is needed, any specific accounts that need to be set up, or any tokens/secrets required for integration.

Awesome

  1. Integration Steps with grammY
  • Provide step-by-step instructions on how to code the payment integration using the grammY framework.
  • Include example code snippets for each relevant step, demonstrating how to set up and handle payments within a bot.

Nice. I usually expect readers to stop reading here because their bot works now.

  1. Advanced Topics and Tips
  • Offer additional tips, tricks, and best practices for working with payments on Telegram.
  • Include information on advanced settings and customization options for payment integration.
  • Provide links to other relevant resources, such as official Telegram documentation or community forums for further exploration.

Great to include this, I'm curious what you'll link here.

  1. Conclusion and Next Steps
  • Summarize the key points covered in the Payments Guide.
  • Encourage users to explore the provided information and experiment with payment integration.
  • Suggest possible next steps or related topics for further learning.

Drop the summary. If we feel like we need a summary then the page isn't concise enough. Next steps are cool, but they can also be included along the way (“if you want to know more about this step, look here”) rather than at the end of the page.

  1. Review and Feedback
  • Invite users to provide feedback on the documentation, ensuring clarity and completeness.
  • Consider involving other individuals or stakeholders to review and offer their opinions on the guide.

This sounds like ChatGPT generated it. Sounds pointless to me. It isn't related to payments in any way and we already have this content written down elsewhere. What are the stakeholders even?

I took all my writing from my notes, then my correspondence with my friends and threw it into Chat GPT, yes. That was about a week ago. Then I removed the unnecessary theses and the last item was added by me, we have such a thing in plugins, but since you don't think it's necessary, then okay.

@LWJerri
Copy link
Collaborator

LWJerri commented Jun 19, 2023

I had to organize everything somehow, because there was a lot of different information, which was even duplicated. Chat GPT organized it for me and gave me a brief summary of what should have been done.

@KnorpelSenf
Copy link
Member Author

we have such a thing in plugins

What are you referring to?

@LWJerri
Copy link
Collaborator

LWJerri commented Jun 19, 2023

I took all my writing from my notes, then my correspondence with my friends and threw it into Chat GPT, yes. That was about a week ago. Then I removed the unnecessary theses and the last item was added by me, we have such a thing in plugins, but since you don't think it's necessary, then okay.

image

I'm say about this.

@KnorpelSenf
Copy link
Member Author

Yes. This is one of the places where we provide information about how to contribute, but it's done once for all plugins. In the guide, we will not do this after every single article. Same for the advanced section or the docs of a particular plugin.

@LWJerri LWJerri changed the title feat: Payments guide feat: Telegram payments guide Jun 28, 2023
@LWJerri LWJerri removed a link to a pull request Apr 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants