Portal Structure

Our documentation portal is designed to provide an intuitive and user-friendly experience. Below, you'll find information on how to navigate the portal and what you can expect to find.

Navigation Bar

The navigation bar across the top has the following items:

1. Home: This link takes you back to the original landing page.
2. API Catalog: This link takes you to the catalog where all the API documentation is mapped, allowing you to select the API documentation you wish to view.
3. Search Option: At the top right, there is a search option to help find documentation within the portal.
4. Light/Dark Mode Toggle: A button to alternate between light and dark mode of the screen.

Home Page

On the home page, there is also a navigation bar down the left that provides links to high-level resources.

• Information Dropdown: This dropdown provides essential information regarding the API and how to use the feedback tool in this portal.
• API Catalog: This link takes you to the same location as the top navigation bar link, allowing you to access the API catalog.
• Quick Start: This section provides different options for testing the API and downloading necessary resources. It offers users the flexibility to choose from various options based on their needs. For ease of reference, this section is replicated on each product page.
• Resource Links: This section displays a tiled selection of resources sourced from our Freshservice help site, offering additional guidance and support materials.
• Change Log: Any changes made to the API are documented here, along with any additional information about resources that have been added or edited.

Individual API Product Pages

Inside each individual API product, the sidebar will change from the home page and will have the following structure:

1. Introduction:
   This section provides a quick overview of the product, including its purpose and key features. It also introduces the layout of the product documentation, explaining how to navigate through the available sections.

   Additionally, this section includes a Resources subsection, which lists all the resources available for the product. These resources may include links to process flows, parameter dependency charts, and other helpful materials to assist with using the product effectively.

2. Getting Started:
   This section contains information on how to begin using the API. It provides step-by-step instructions and follows the same process for all API pages to ensure consistency.

3. Product Documentation:
   This dropdown provides specific help information for the product. It may include, but is not limited to:

   • Process flows
   • Parameter dependency charts
   • Detailed information for specific product API dependencies

4. API Documentation:
   This section allows you to view the actual API documentation for the product.

By understanding this structure, you can navigate the portal more effectively and find the information you need quickly.

We hope this guide helps you make the most of our documentation portal. If you have any feedback, please use the feedback tool available on each page.