Skip to content

Conversation

@nglebm19
Copy link

@nglebm19 nglebm19 commented Sep 19, 2025

Summary

Added a complete beginner's setup guide for new MentraOS developers.

Changes

  • ✅ Complete step-by-step setup instructions for all platforms (Windows, macOS, Linux)
  • ✅ Smart glasses compatibility table and setup guide
  • ✅ Troubleshooting section for common issues
  • ✅ Clear next steps and community resources
  • ✅ Architecture explanation with diagrams

Target Audience

Complete beginners with no prior MentraOS experience

Testing

  • Verified MDX syntax
  • Checked all links and references
  • Reviewed for clarity and completeness

Issues

#1221

@nglebm19 nglebm19 requested a review from a team as a code owner September 19, 2025 21:11
@aisraelov
Copy link
Member

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

Copy link
Contributor

@isaiahb isaiahb left a 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!

@isaiahb
Copy link
Contributor

isaiahb commented Sep 27, 2025

@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?

@nic-olo nic-olo changed the base branch from main to dev October 2, 2025 02:06
@isaiahb isaiahb requested a review from Drakonheart October 2, 2025 17:25
Copy link
Contributor

@Drakonheart Drakonheart left a 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.

@nic-olo
Copy link
Member

nic-olo commented Oct 18, 2025

@nglebm19 isn't replying. @Drakonheart can you please make these changes yourself so we can merge this PR?

@nic-olo nic-olo requested a review from Drakonheart October 18, 2025 08:34
@nglebm19
Copy link
Author

Hi @Drakonheart
Sorry for the delay – I've been swamped with midterms and didn't have time to check your feedback until now.

Thanks for the detailed review! I've made the following updates:
✅ Added beginner-setup-guide to the navigation in docs.json - it now shows up in the sidebar under "Getting Started"
✅ Enhanced cross-references between the beginner guide and the cloud setup guide so users know which one to follow
✅ Both guides now link to each other for better discoverability
I kept them as separate docs since they serve different audiences (complete beginners vs. cloud developers), but they're now properly connected with clear signposting.
Should be good to go now! Feel free to let me know if you need anything else.
Thanks for your patience!

@nic-olo nic-olo requested a review from isaiahb October 20, 2025 02:57
@Drakonheart
Copy link
Contributor

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.

@nglebm19
Copy link
Author

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!

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.

5 participants