Skip to content

Gem docs are extremely lacking #119

Open
@ess

Description

@ess

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions