Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gem docs are extremely lacking #119

Open
ess opened this issue Apr 14, 2020 · 0 comments
Open

Gem docs are extremely lacking #119

ess opened this issue Apr 14, 2020 · 0 comments
Assignees

Comments

@ess
Copy link
Contributor

ess commented Apr 14, 2020

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 Documentation #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
@ess ess self-assigned this Apr 14, 2020
@ess ess changed the title Gem docs do not cover the CLI Gem docs are extremely lacking Apr 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant