Comments (12)
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.
from website.
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.
from website.
@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.
from website.
My typical approach to writing these pages is:
- What does this feature do? (Bot dev accept payments from users, link to TG docs)
- 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?)
- What do I need to get started? (Credit card? Any accounts? Any tokens/secrets?)
- How can this be coded with grammY? (Example code snippets for each relevant step in 2.)
- 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. :)
from website.
Okay, then I will prepare some information base and try to write something.
from website.
Feel free to share early drafts so we can iterate on the changes together :)
from website.
Soooo, this is my structure for the Telegram payments guide. @KnorpelSenf, what do you think about it?
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
from website.
- 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.
- 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).
- 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.
- 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
- 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.
- 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.
- 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.
- 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?
from website.
- 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.
- 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).
- 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.
- 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
- 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.
- 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.
- 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.
- 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.
from website.
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.
from website.
we have such a thing in plugins
What are you referring to?
from website.
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.
I'm say about this.
from website.
Related Issues (20)
- Links on the main page are not underlined on hover HOT 5
- Update info on Heroku in Hosting Comparison HOT 5
- feat: `SetWebhookUtil` component HOT 1
- feat: contribution guide and website tooling documentation HOT 1
- Wrong commit order for restoring Chinese HOT 1
- feat: Expand on parse-mode docs HOT 2
- fix: "no filesystem on Deno Deploy" statement is wrong
- Russian translation tracking HOT 4
- Move the notifier bot to independent repository HOT 2
- Ukrainian translation tracking HOT 12
- The search has duplicate results HOT 2
- Sync supported framework adapters HOT 1
- Use /types in examples
- Italian translation tracking HOT 3
- Add guide for hosting on deta.space HOT 5
- Tutorial problem HOT 5
- Improving the guide to hosting bots on VPS HOT 3
- Type issue
- Outdated load docs
- Do not mention throttling in the deployment checklist HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from website.