search

ARMmbed / mbed-cli

Arm Mbed Command Line Interface
https://os.mbed.com
Apache License 2.0
334 stars 176 forks source link

README doesn't link to documentation. #978

Open hpigot opened 4 years ago

hpigot commented 4 years ago

README.rst states "The best way to get started is to read the documentation on GitHub." but just links back to itself. https://github.com/ARMmbed/mbed-cli/blob/master/README.rst

Include link to documentation.

ciarmcom commented 4 years ago

Thank you for raising this detailed GitHub issue. I am now notifying our internal issue triagers. Internal Jira reference: https://jira.arm.com/browse/IOTBTOOL-832

mnaberez commented 4 years ago

README.rst states "The best way to get started is to read the documentation on GitHub." but just links back to itself. https://github.com/ARMmbed/mbed-cli/blob/master/README.rst

The README.rst file is used as the PyPI project description. This is a common pattern with Python packages. The link provides a way for PyPI users to get to the GitHub repository.

hpigot commented 4 years ago

It would be helpful if the README also included a link to the latest documentation, which seems pretty non-existent in the master branch https://github.com/ARMmbed/mbed-cli/blob/master/docs/index.md Is there somewhere else users should look to find up to date documentation for mbed CLI?