Skip to content

Diego API documentation should be more easily discoverable #58

@shalako

Description

@shalako

As a consumer of Diego, I care most about two things:

  1. How to deploy it
  2. Public interfaces

The README does mention use of CF, however Diego's API docs are buried in a docs directory in the Receptor repo (not even in the README for Receptor), to which there is no link on the diego-release README. I did eventually find a link to the API docs in the design notes repo.

The user experience would be improved if there were a link to the API docs on the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions