zmk icon indicating copy to clipboard operation
zmk copied to clipboard

docs: Devcontainers-cli enhancement

Open Pauiii opened this issue 1 year ago • 1 comments

Documentation enhancement for local setup with the devcontainers-cli like mentioned on Discord.

  • Splitted Docker documentation into VSCode and Devcontainers CLI
  • Add overall Docker setup instruction
  • Adjust the Building & Flashing documentation by moving Docker related information into the Docker documentation

Additionally, I added a new volume for modules to the devcontainer.json, so that it can be used for building locally with external modules.

Pauiii avatar Oct 10 '24 18:10 Pauiii

Hey, thanks for writing this! It looks pretty good, and I've been wanting someone to tackle this for a while. I have some larger thoughts listed below, more detailed pass pending them being addressed.

Thanks for the review! I will have a look at everything and try to make adjustments accordingly.

Pauiii avatar Oct 15 '24 06:10 Pauiii

Just some minor rephrasing.

Sure, I adjusted everything.

Pauiii avatar Oct 26 '24 09:10 Pauiii

For future contributions, it'd be great if we can avoid reformatting lines in existing content. It adds a lot of noise to the diff for not much benefit.

Just as a side note, I personally am in favor of reformatting such that each sentence begins on a new line in the file. This just makes it easier to review, imo.

nmunnich avatar Oct 27 '24 08:10 nmunnich

Thank you both for your work, looks good to me besides a few small things noted.

For future contributions, it'd be great if we can avoid reformatting lines in existing content. It adds a lot of noise to the diff for not much benefit.

Applied everything you mentioned. Sure I will keep it in mind.

Pauiii avatar Oct 27 '24 19:10 Pauiii