Skip to content
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

docs: Add details for Ergonaut One build guide #31

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

drklee3
Copy link

@drklee3 drklee3 commented Oct 25, 2024

Thanks for the fantastic project! These changes were from my experience while building an Ergonaut One

Build preparation changes:

  • Add details about using JLCPCB / PCBWay for 3D printing, as I also don't have access to a 3D printer

Build guide changes:

  • Adjust configuration options to be more clear
  • Add additional build steps for less experienced users
  • Make notes and warnings more clear with Docusaurus admonitions

This does include a handful of different changes so please do let me know if there's any sections that are incorrect or if there's formatting changes that are not preferred.

General additions that may reduce any uncertanties for someone going
through the build guide for the first time.
Add additional details for those without access to a 3D printer,
referencing the existing PCB manufacturers for convenience.
The previous link includes 1000 pieces which is a bit more than
necessary for this build. Replacement link is much cheaper and 100
pieces instead.
"Bottom Xiao" configuration: sockets should be on the **SAME** side as Xiao.
"Top Xiao" configuration: sockets should be on the **OPPOSITE** side from Xiao.

The orientation of the sockets does **not** matter.
Copy link
Author

Choose a reason for hiding this comment

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

I'm still uncertain on this if the orientation actually matters or not for these sockets. I couldn't find any resources about the correct orientation, but just followed the images in the guide that needed zooming in to check.

Confirmation on if this is accurate or not would be great 😃

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.

1 participant