Page MenuHomePhabricator

Review and improve top viewed overview pages of the Action API
Closed, ResolvedPublic


As per Phase 2 of Action API documentation improvement, review and improve the following top viewed overview pages of the Action API:

Event Timeline

srishakatux created this task.

Below are some super quick recommendations for these overview pages--

  1. These are highly visited/popular pages -- check to see if there is any feedback on the discussion pages (questions, requests for improvement, etc). After revisiting these pages, please encourage visitors and collaborators to leave feedback about what is working and what is not working.
  2. Make sure these pages meet the requirements of the documentation/style guide.
  3. Individual Recommendations:
  • API:Client_code
  • Check to make sure the information is up-to-date.
  • Page should have tables (recommended) or no tables for all of the client libraries. Right now, there is a mix of formatting for these. It should be consistent.
  • A subtask has been created to address more substantive changes.
  • API:Data formats
  • Edit with an eye for clarity and reducing amount of text (especially in Multivalue parameters and output section).
  • Think reference over user guide.
  • Check accuracy of examples provided at end of page.
  • A subtask has been created for this.
  • API:Properties
  • No major recommendations - make sure information is accurate.
  • API:Error and warnings
  • No major recommendations -- make sure information is accurate. This page should be connect to a troubleshooting guide.
  • This page could definitely use a complete overhaul. Content should be evaluated and reorganized for clarity. This page can also be used to contextualize APIs in general. Because the work on this will be a bit more involved, I'm creating a subtask with recommendations for this page.
  • API:Cross-site_requests
  • Check information accuracy and edit with an eye for clarity.
Legoktm changed the edit policy from "Custom Policy" to "All Users".Sep 19 2018, 9:52 PM

(thanks to @jeropbrenda for working on the API overview pages as part of Outreachy internship! )