search

pycom / pydocs

4 stars 4 forks source link

Missing Documentation #5

Open abradbury opened 5 years ago

abradbury commented 5 years ago

(Hi! 👋 Thanks for reporting an issue! Please make sure you click the link above to view the issue guidelines, then fill out the blanks below.)

What are the steps to reproduce this issue?

  1. Links to pymakr Atom and Visual Studio code documentation are not displaying at https://docs.pycom.io/gettingstarted/installation/pymakr.html (source)
  2. The documentation on the firmware update tool is out of date and incomplete:
    1. There are only tabs on this page for exp board 2.0 and exp board 3.0, what about those new to Pycom that have another type of board? e.g. Pytrack, fipy etc.
    2. The screenshot of the "communication" screen of the update tool has changed significantly - there are now a lot of extra options that are unclear to the new user (yes, it is possible to understand what these are by searching through forums, the rest of the documentation and the internet, but I think it should be a lot clearer, given this is a "getting started" guide), for example:
      1. High speed file transfer: why would I not want this checked?
      2. Erase flash file system: why would I want to do this? Should I do this?
      3. Force update of LoRa region: same as above, should I be doing this as I'm following the "getting started" guide?
      4. Type: stable, development, pybytes: not clear without context, eventually you could perhaps figure out that this means "firmware type" - from which stable and development can be inferred, but "pybtyes" is not clear. Clicking the link takes you to a page that used to have no information without you having to create an account and login, not great if you want to find out what it is first. Now there is some information, but not much.
      5. It might be useful to note that pressing "continue" on this page begins the firmware update process (or change the button to say something else)

What happens?

Confusion, and wasted time until a solution is found elsewhere on the internet, somewhere else in the documentation or on the forums.

What were you expecting to happen?

That the getting started guide would be more complete and up-to-date

Any logs, error output, etc?

(If it’s long, please paste to https://gist.github.com and insert the link here)

Any other comments?

What versions of software are you using?

N/A