bluerobotics / bluerobotics/BlueOS

Improve first time setup for new devs

Open
#3,480 0 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Vue
Stars
453
Forks
151
Avg merge
1d 3h
Merged PRs (30d)
174

Description

While setting up my environment I encountered some undocumented or hard-to-find steps that could be improved for newcomers.To enhance the _Development_ section in the wiki page as a way to make it more begginer-friendly, I suggest we:
- Add a sub section in **"How to build"** suggesting the use of DockerHub as an alternative to `buildx`;
- Add a README.md for frontend debugging including the dependencies for `bun` and the `BLUEOS_ADDRESS=http:// bun run dev` command;
- Add the execution of `git submodule update --init --recursive` in the setup steps;
- Add a note to inform that depending on the OS (e.g. Arch Linux) it will be necessary to configure Avahi to identify and access the BlueOS on `blueos-avahi.local`.
- Link the Development Wiki with the [BlueOS docs](https://blueos.cloud/docs/latest/development/overview/) and vice-versa, or just unify everything in one place;
- When configuring buildx locally I had to do two extra steps:
1. install `qemu-user-static-binfmt` and `qemu-user-static`
2. execute `docker run --privileged --rm tonistiigi/binfmt --install all`

Lastly, I think it would be nice to link the Developer Wiki from the main `README.md`.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.