Good documentation increases the probability that consumers use a Service correctly. The OpenAPI spec provides useful information, such as HTTP method types and expected request and response formats. In Service documentation, you can provide images and other details, such as the type of authorization required. This information displays to consumers when they click on the Service in the DeveloperHub to view its details.

Provide documentation content in Markdown format. Refer to the Markdown cheat sheet for syntax. The DeveloperHub renders the Markdown in HTML as shown below:

DeveloperHub organizes Services by categories. A Service can belong to multiple categories or no category. By default, the DeveloperHub Service catalog page provides links to each category and an All Services. However, if the All Categories toggle for the catalog is disabled, Services with no category won't be visible in the DeveloperHub.

To add documentation:

• Navigate to the correct version of the Service.
• Click the Documentation tab.
• Choose or add DevHub category. You can choose multiple categories and the Service displays under all of them.
• Optionally, upload a DevHub image or choose one from the Gallery.
• In the DevHub details page content field, enter the Markdown text.
• Click Submit.

Open the DeveloperHub catalog page and click your Service to check the documentation.