Submission: Interledger Wallet Payout – ssaincity#15
Submission: Interledger Wallet Payout – ssaincity#15Hussman256 wants to merge 1 commit intoWriteTech-Hub:mainfrom
Conversation
|
Hello, thank you for the feedback. Was I among the winners?
…On Mon, Aug 11, 2025 at 3:50 AM Phylis Atieno ***@***.***> wrote:
*phyleria* left a comment (WriteTech-Hub/wth-write-a-thon#15)
<#15 (comment)>
Hi @Hussman256 <https://github.com/Hussman256> ,
Thank you for submitting your articles! Here's the feedback from our end:
Your *setup guide* is a helpful start but doesn’t yet read as a full
integration walkthrough. To make it more beginner-friendly, it would
benefit from clearer explanations, visual aids, detailed endpoint
documentation, and guidance on error handling. Also, matching the exact
Chimoney API endpoints and parameters and including a brief example of a
successful JSON response would help users verify their setup more
confidently.
The *tutorial guide* includes useful prerequisites, which is a great
start. However, the overall content could be clearer and easier to follow.
Adding more context and simple explanations about how the API works would
help readers better understand what’s happening and why. Following the
submission guidelines closely is also important to keep consistency across
all entries.
Your *use case guide* presents the problem and solution clearly using a
real-world scenario, which helps readers grasp the basics of Chimoney’s
Interledger payout endpoint. To make it even more engaging, it could be
developed with deeper technical details, persuasive storytelling, and a
fuller explanation of the impact and measurable benefits. Including a
walkthrough of how the API works with examples would add real value for
readers interested in implementing the solution.
Thank you again for your participation and hard work. We hope this
feedback helps!
—
Reply to this email directly, view it on GitHub
<#15 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BKMHS6WELQHL7AKVR43NIGD3NBYQJAVCNFSM6AAAAACCYI6IK6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCNZUGIYDQMZTHA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Hi @Hussman256, Thank you for for following up! Unfortunately, you weren’t among the winners this time, but we truly appreciate your effort and hope you’ll join our future challenges. |
There was a problem hiding this comment.
Hi @Hussman256. Thanks for putting this together!
It’s a good start, but right now the tutorial doesn't read too much like a guide. To make it clearer and easier for your reader to follow, you should:
- Add a short explanation before each step so readers understand what they’re doing and why. This can also include very brief explanations of what the code block for that section does.
- Connect the steps with transition sentences so the tutorial flows naturally from start to finish.
- Include a section on common errors and how to fix them.
- Add a short conclusion to wrap up the tutorial.
- Link to other helpful resources where it necessary.
- Move your files into the correct folder format so we don’t run into problems when merging:
submissions/
└── [endpoint]-[slackhandle]/
├── use-case.md
├── tutorial.md
└── setup.md
Once you make these changes, your tutorial will be much easier to follow and ready to merge.
OfficialJhimmy
left a comment
There was a problem hiding this comment.
Hi @Hussman256 , thank you for submitting this guide! You’ve covered the main steps needed to set up Chimoney payouts, which is great. I can see the effort you put into simplifying the process, but there are a few areas that can really make your tutorial much stronger and more helpful for beginners.
Here are my thoughts:
-
Structure and Flow
• The steps are listed clearly, but they read more like a quick checklist than a full tutorial. For example, in Step 1 you tell readers to sign up and get their API key, but you don’t explain why they need the API key or what it does. Adding that context makes it easier to understand the importance of each step.
• Try adding short transitions between steps. For instance: after creating an account, you could say “Now that you have your API key, let’s set up your development environment so you can use it.” That way, the guide feels like a journey instead of disconnected tasks. -
Clarity and Detail
• Some instructions are too brief and may confuse beginners. For example, Step 4 just says “Sign up at rafiki.money” without explaining what Rafiki is or why they need an Interledger wallet. A beginner might not understand how that connects to Chimoney payouts.
• Your code samples are useful, but you should explain what’s happening in plain English. For instance, before showing the .env setup, explain that environment variables are used to keep sensitive data like API keys safe. -
Tone and Readability
• The tutorial feels a little rushed and technical. Try writing as if you are guiding a friend. For example, instead of just saying “Copy your API key,” you could say “Copy your API key and keep it safe. You’ll need it in the next step when we connect your code to Chimoney.”
• Breaking long code blocks into smaller parts with explanations in between would help readers understand better instead of just copying and pasting. -
Writing Best Practices
• Right now the tutorial jumps straight into commands and code without much context. Adding a short introduction at the top (what the tutorial will help the reader achieve and what they need before starting) will give readers confidence.
• At the end, it would be nice to include a short “What’s Next” section to tell readers where they can go from here, like checking more endpoints or exploring the developer docs.
Overall, your guide is a solid starting point, but it needs more explanation and friendlier wording to be useful for beginners. Think about why each step matters and explain it in simple terms before giving commands or code. If you try reading your tutorial as if you’ve never heard of Chimoney before, you’ll quickly notice the areas that feel unclear.
Hello @phyleria, @adebayoileri
This is my technical writing submission for the Chimoney Writer Bounty.
✅ I chose the endpoint:
Payout to Interledger Wallet Address✅ My submission includes all 3 required deliverables:
use-case.md– A real-world scenario on using Chimoney to pay remote hackathon winners via Interledgertutorial.md– Step-by-step integration using Node.js, Axios, and JavaScriptsetup.md– Full guide to environment setup, API key config, and first test call