Skip to content

content review for the API doc page

In view of opening up the API, we need to thoroughly review the content of each endpoint listed in the API doc page.

The following action items come to mind, but more might be needed and added later:

  • we are not going to open up //all// endpoints, so some of them will need to be hidden/removed. How can we do that without having to remove the actual doc from the code? (#631 (closed))
  • we need an introductory paragraph at the beginning of the page, which is not tied to any particular endpoint, to explain what this page is (#630 (closed))
  • we need to review each endpoint description for content, uniformity of language, etc.

Migrated from T621 (view on Phabricator)

Edited by Phabricator Migration user