sqfmi / watchy-docs

Watchy Documentation Website
MIT License
33 stars 55 forks source link

Multiple issues with getting-started.md #77

Open BenAveling opened 1 month ago

BenAveling commented 1 month ago

Image shows that the vibrating engine needs to be attached, which is no longer the case.

Instructions do not mention the black pins that should hold the ribbon cable in place.

Instructions say to insert ribbon cable before inserting battery, but figure shows battery being connected before the ribbon cable.

Instructions say to install esp32 - but as well as esp32, there is also "Arduino ESP32 Boards", which looks more official, but appears not to be right, so probably worth a warning here.

Latest v2 version of esp32 is v2.0.18, should say whether to use this instead of v2.0.17, or not.

Instructions say 'Choose an example' but do not say what the steps involved in choosing an example are - they might be obvious to an experienced person, but not to the casual user.

There are some minor grammatical errors.

I've raised a pull request that would address some of these issues, not of them: https://github.com/sqfmi/watchy-docs/pull/76