Skip to content

payout-mercyoyelude2 submission#10

Open
Mercy-Iyanu wants to merge 6 commits intoWriteTech-Hub:mainfrom
Mercy-Iyanu:payout-mercyoyelude2
Open

payout-mercyoyelude2 submission#10
Mercy-Iyanu wants to merge 6 commits intoWriteTech-Hub:mainfrom
Mercy-Iyanu:payout-mercyoyelude2

Conversation

@Mercy-Iyanu
Copy link

@phyleria @adebayoileri kindly review.

@Mercy-Iyanu Mercy-Iyanu requested a review from a team as a code owner July 30, 2025 14:48
@phyleria
Copy link
Collaborator

Hi @Mercy-Iyanu,

The submission flow looks good. We’ll do an official review once the deadline has passed. Thank you!

@Mercy-Iyanu
Copy link
Author

Hi @Mercy-Iyanu,

The submission flow looks good. We’ll do an official review once the deadline has passed. Thank you!

Thanks for the update, @phyleria! Looking forward to the review.

Copy link

@OfficialJhimmy OfficialJhimmy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Mercy-Iyanu, thank you for putting this tutorial together! I really like how you added icons, examples, and screenshots to make the guide feel more engaging and beginner-friendly. That said, I have a few suggestions that can help polish the tutorial and make it easier for readers to follow from start to finish.

Here are some things you could work on:

  1. Structure and flow
    • Right now, the tutorial jumps straight into prerequisites and then testing the endpoint, but it doesn’t set much context. A short introduction that explains what the endpoint does and why someone would use it would help beginners connect the dots.

    • Some sections feel more like notes than step-by-step guidance. For example, the “Common Errors” part is very useful, but it could flow better if each error explanation followed a consistent format (Error → Why → Fix).

  2. Clarity and explanations
    • Some instructions are listed without explaining why the reader is doing them. For instance, when you say “Click Authorize and paste your API key,” it would help to add a quick note like: “This step authenticates your requests so the API knows who is calling.”

    • Same with the currency mismatch issue, you mention the fix, but it would help to explain why Chimoney restricts certain wallets to USD only. A little background helps the reader learn, not just copy-paste.

  3. Consistency in writing style
    • You use a mix of casual expressions like “Boom” and “Happy building!” along with formal API instructions. The tone is fun, but for a technical guide, it’s best to keep it consistent and clear. You can still be friendly without losing professionalism.

    • Be careful with formatting. For example, sometimes you use code blocks for errors, other times just inline text. Keeping them consistent makes scanning easier.

    1. Grammar and readability
      • Some sentences are missing small words or have awkward phrasing. Example: “Account is funded with $1000(10000 Chimoney) of test amount” could be clearer as “Your sandbox account comes preloaded with $1000 (10,000 Chimoney) for testing.”

    • Adding more transition words between steps will make the tutorial feel smoother, rather than a collection of separate notes.

Best practices
• Right now, everything is shown inside the Swagger UI. It would be nice to also give a short cURL or Postman example so readers can practice outside the API Explorer.

• Since you already mentioned environment variables in earlier parts, reminding readers to avoid hardcoding API keys here would strengthen the guide.

Overall, you did a solid job explaining errors and showing success responses, which many tutorials forget to include. With a bit more explanation between steps, tighter grammar, and a more consistent structure, this guide could be really strong.

@Mercy-Iyanu
Copy link
Author

Hi @Mercy-Iyanu, thank you for putting this tutorial together! I really like how you added icons, examples, and screenshots to make the guide feel more engaging and beginner-friendly. That said, I have a few suggestions that can help polish the tutorial and make it easier for readers to follow from start to finish.

Here are some things you could work on:

  1. Structure and flow
    • Right now, the tutorial jumps straight into prerequisites and then testing the endpoint, but it doesn’t set much context. A short introduction that explains what the endpoint does and why someone would use it would help beginners connect the dots.
    • Some sections feel more like notes than step-by-step guidance. For example, the “Common Errors” part is very useful, but it could flow better if each error explanation followed a consistent format (Error → Why → Fix).

  2. Clarity and explanations
    • Some instructions are listed without explaining why the reader is doing them. For instance, when you say “Click Authorize and paste your API key,” it would help to add a quick note like: “This step authenticates your requests so the API knows who is calling.”
    • Same with the currency mismatch issue, you mention the fix, but it would help to explain why Chimoney restricts certain wallets to USD only. A little background helps the reader learn, not just copy-paste.

  3. Consistency in writing style
    • You use a mix of casual expressions like “Boom” and “Happy building!” along with formal API instructions. The tone is fun, but for a technical guide, it’s best to keep it consistent and clear. You can still be friendly without losing professionalism.
    • Be careful with formatting. For example, sometimes you use code blocks for errors, other times just inline text. Keeping them consistent makes scanning easier.

    1. Grammar and readability
      • Some sentences are missing small words or have awkward phrasing. Example: “Account is funded with $1000(10000 Chimoney) of test amount” could be clearer as “Your sandbox account comes preloaded with $1000 (10,000 Chimoney) for testing.”

    • Adding more transition words between steps will make the tutorial feel smoother, rather than a collection of separate notes.

Best practices • Right now, everything is shown inside the Swagger UI. It would be nice to also give a short cURL or Postman example so readers can practice outside the API Explorer.

• Since you already mentioned environment variables in earlier parts, reminding readers to avoid hardcoding API keys here would strengthen the guide.

Overall, you did a solid job explaining errors and showing success responses, which many tutorials forget to include. With a bit more explanation between steps, tighter grammar, and a more consistent structure, this guide could be really strong.

@OfficialJhimmy,
Thank you for your feedback on the setup! I have made the following updates based on your suggestions:

  • added more context at the beginning to explain the purpose
  • included the cURL and Postman examples for testing
  • made a few grammatical adjustments for better readability and flow

Let me know if I still need to make any more changes before merging.

- included more specific errors
- added a brief paragraph to step 3
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

Successfully merging this pull request may close these issues.

4 participants