-
Couldn't load subscription status.
- Fork 170
docs: add comprehensive beginner setup guide for MentraOS development #1246
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
base: dev
Are you sure you want to change the base?
docs: add comprehensive beginner setup guide for MentraOS development #1246
Conversation
|
@isaiahb or @Drakonheart check this out when you get a chance. I think could use some tweaking (ex: don't include Android/iOS SDK stuff in the Mentra SDK... this would confuse users). But a general easy to understand overview could be worthwhile. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is awesome, thank you!
|
@aisraelov should we rename it so it's more clear this is setup is not required for developing apps using the SDK, just for making changes to the underlying mobile app and or cloud? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is awesome, @nglebm19 ! I really liked the way you went into so much detail, and the diagram is great too.
One question I had, would it be possible to combine this with the other file that also goes into detail about setting up Mentra OS locally and in the cloud (MentraOS/cloud/docs/development/local-setup.mdx)?
I’m assuming you were using Mintlify to check if everything worked, though when I ran it I couldn’t find the doc you created. I had to manually go to http://localhost:3001/beginner-setup-guide to get to your page.
Other than that, if you could fix those few things, it should be good to go, boss.
Sorry for the late response, the team has been really busy.
Thanks again,
A.F.P.
…memory-leak-hotfix Cloud/memory leak hotfix
…livekit-ios-bug HOTFIX - Ensure sessions are cleaned up after grace period
|
@nglebm19 isn't replying. @Drakonheart can you please make these changes yourself so we can merge this PR? |
…livekit-ios-bug HOTFIX make sure livekit go bridge sends logs to betterstack for debugging
…livekit-ios-bug HOTFIX: add more debug logs to go livekit bridge
…, default to off / little-endian
…livekit-ios-bug HOTFIX: disable endianness auto swapping for audio chunks from livekit-bridge…
|
Hi @Drakonheart Thanks for the detailed review! I've made the following updates: |
|
Hey @nglebm19 ! Sorry we missed you earlier; the team’s been super busy lately. We had a discussion about your PR, and I just want to say it’s awesome. We really appreciate the time and thought you put into it. After reviewing it, we realized that right now there isn’t a perfect place to fit it into our current documentation hierarchy without possibly confusing new developers. That said, your work actually highlighted something important, we really need a dedicated section for contributor and third-party developer documentation. We’re in the process of creating a more organized documentation structure with a stronger focus on those areas. Once that’s ready, we’d love to revisit your PR and integrate it properly. For now, we’ll keep your PR open, and when the time comes, we’ll reach out to you directly. Thanks again for your patience and for putting so much care into your contribution; it really means a lot to us. |
|
Hey @Drakonheart, No worries at all — totally understand how things can get hectic! Thanks so much for the thoughtful feedback and the kind words. I really appreciate you and the team taking the time to review my PR so thoroughly. That all makes perfect sense. I completely agree that having a dedicated section for contributor and third-party developer documentation would make things much clearer. I’m glad my PR could help highlight that gap. I’ll keep an eye out for updates on the new documentation structure, and I’m more than happy to revisit and adapt my contribution once that’s in place. Thanks again for keeping me in the loop — really appreciate the open communication and support! |
Summary
Added a complete beginner's setup guide for new MentraOS developers.
Changes
Target Audience
Complete beginners with no prior MentraOS experience
Testing
Issues
#1221