Configure documentation settings
The generated documentation can be configured using either your liblab config file on a per-SDK basis, or at an organization level using settings in the liblab portal.
SDK documentation settings
In your liblab config file, you can configure the following settings for your documentation. See the documentation for each of these config file options for more details.
includeOptionalSnippetParameters- this option determines if optional and deprecated parameters should be included in the code snippets in generated documentation or not.
Organization level documentation settings
From the liblab portal, you can configure the following settings for your documentation at an organization level:
These changes will affect newly created documentation and will not affect existing documentation.
Organization logo
Your organization logo is displayed in the top left corner of the documentation. This is set in the organization settings and is applied to all documentation within the organization. Only users with the Admin role can set the organization logo.
To set the logo, follow these steps:
- From the liblab portal, select the Settings menu
- Add the URL of your logo to the Logo (URL) field
- Select the Save button to save the changes
