omi icon indicating copy to clipboard operation
omi copied to clipboard
verified publisher icon BasedHardware

Docs for SDK

Open kodjima33 opened this issue 9 months ago • 6 comments

Need to write really good docs for SDK. See parent task

/bounty $200

kodjima33 avatar Mar 25 '25 08:03 kodjima33

💎 $200 bounty • omi

Steps to solve:

  1. Start working: Comment /attempt #2077 with your implementation plan
  2. Submit work: Create a pull request including /claim #2077 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to BasedHardware/omi!

Add a bounty • Share on socials

Attempt Started (GMT+0) Solution
🟢 @ibrahimnd2000 Mar 26, 2025, 8:47:17 AM WIP
🟢 @logicforge17 Apr 2, 2025, 10:56:20 AM WIP

algora-pbc[bot] avatar Mar 25 '25 08:03 algora-pbc[bot]

/attempt #2077

Options

ibrahimnd2000 avatar Mar 26 '25 08:03 ibrahimnd2000

@kodjima33 Maybe we can close this issue as completed

varshith257 avatar Mar 29 '25 09:03 varshith257

#attempt #2077

Implementation Plan:

  1. Review the existing SDK functionality to understand the features and capabilities.
  2. Create comprehensive documentation covering:
    • Installation instructions.
    • Usage examples for key features (e.g., streaming audio, battery monitoring).
    • API reference for developers.
    • Troubleshooting and FAQs.
  3. Use Markdown for formatting and ensure clarity and readability.
  4. Test the documentation by following the steps to ensure accuracy.
  5. Submit the documentation for review and feedback.

WaterlooStudentFund avatar Apr 01 '25 08:04 WaterlooStudentFund

/attempt #2077

Options

SaikiranSurapalli17 avatar Apr 02 '25 10:04 SaikiranSurapalli17

@beastoin Is anything left in this issue?

varshith257 avatar Apr 10 '25 07:04 varshith257