Skip to content

Docs for SDK #2077

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

Open
kodjima33 opened this issue Mar 25, 2025 · 6 comments
Open

Docs for SDK #2077

kodjima33 opened this issue Mar 25, 2025 · 6 comments

Comments

@kodjima33
Copy link
Collaborator

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

/bounty $200

Copy link

algora-pbc bot commented Mar 25, 2025

💎 $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 bountyShare 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

@ibrahimnd2000
Copy link

ibrahimnd2000 commented Mar 26, 2025

/attempt #2077

@varshith257
Copy link

@kodjima33 Maybe we can close this issue as completed

@WaterlooStudentFund
Copy link

#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.

@logicforge17
Copy link

logicforge17 commented Apr 2, 2025

/attempt #2077

@varshith257
Copy link

@beastoin Is anything left in this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

5 participants