Skip to main content

Navigation Guidelines

Welcome to the Quapp Documentation portal! This guide will help you efficiently navigate the available resources to find the information you need. The documentation is organized to cater to users with different roles, from developers to administrators, ensuring a seamless experience.

Documentation Structure​

The sidebar is the primary navigation tool, organized into the following sections:

1. Getting Started

  • An introductory section for new users to quickly set up and understand the platform’s basic features and functionality.

2. Introduction

  • A high-level overview of Quapp Functions, its purpose, and the key components of the platform.

3. User Documentation

  • Step-by-step guides for non-technical users to manage projects, deploy functions, and utilize quantum resources effectively.

4. Developer Documentation

  • Resources for developers, including advanced technical guides, sample code, and integration instructions.

5. Platform Capabilities

  • Details about the features and functionalities offered by Quapp Functions, such as job orchestration, provider integration, and resource management.

6. API Documentation

  • Comprehensive information on Quapp’s APIs, including endpoint details, authentication, and example usage scenarios.

7. Support Policies and Legal Documentation

  • Information on support services, terms of use, and other legal considerations.

8. Terminology Glossary

  • Definitions and explanations of key terms used throughout the platform and documentation.

9. Frequently Asked Questions (FAQs)

  • Quick answers to common questions about the platform and its features.

10. Release Notes 

- Updates on new features, bug fixes, and changes in the latest versions of Quapp Functions.

Key Navigation Features​

1. Sidebar Navigation

  • The sidebar is always visible and allows you to access major sections quickly. Click the arrows (>) next to each category to expand and reveal subsections.

2. Breadcrumb Trail

  • Located at the top of each page, the breadcrumb trail helps you track your current location and navigate back to parent sections.

3. Interactive Links

  • Each section and subsection contains clickable links to related content, external resources, or further reading.

Tips for Efficient Navigation​

  • Start with “Getting Started”: If you’re new to Quapp, this section provides an excellent foundation.
  • Explore User or Developer Guides: Depending on your role, dive into the relevant guides for in-depth tutorials and best practices.
  • Use the Glossary: Unsure about terminology? The glossary is your go-to resource for definitions.
  • Stay Updated with Release Notes: Check this section regularly to stay informed about platform updates and new features.