README doesn't link to documentation.
Open
Jira status: OPEN
mirrored
type: bug
- Dominant language
- Python
- Stars
- 339
- Forks
- 187
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open README.rst and inspect the sentence that says the documentation is on GitHub, along with its current self-link. Replace that link with the project's documentation destination, then verify the rendered README points to the documentation rather than README.rst.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100