engineyard / engineyard/core-client-rb
Gem docs are extremely lacking
- Dominant language
- Ruby
- Stars
- 4
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
Here are a few documentation issues that have been highlighted specific to this gem:
* The primary CLI app that customers use to interact with their Engine Yard assets now lives in this project, but there is not even a mention of that in the docs, let alone usage instructions
* Aside from a few examples, there are no actual library usage instructions within the gem
* There is almost zero actual library documentation (as one might find on https://rubydoc.info )
* As @lucis-fluxum points out in #109 , the actual API docs listed at https://developer.engineyard.com are missing information and are generally inconsistent. That issue belongs to another project, but it directly impacts this project as well, so we are making note of this here
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.