About this documentation

Welcome to the SerenityGPT Knowledge Hub. This documentation is designed to provide comprehensive information about SerenityGPT, our enterprise search solution. Whether you're a business decision-maker evaluating our product or a technical user implementing and configuring SerenityGPT, you'll find valuable information here.

Purpose of the documentation

The primary goals of this documentation are to:

1. Provide a clear understanding of SerenityGPT's capabilities and benefits.
2. Guide users through the setup and configuration process.
3. Offer detailed technical references for advanced users and integrators.
4. Answer common questions and provide troubleshooting assistance.

Layout

This documentation is divided into sections that fall into the following categories:

1. Overview: Conceptual information to provide context and deepen understanding.
2. Getting started: Pre-requisites and instructions for getting started with deployment.
3. How-to guides: Guides on deployment and usage of the application.
4. Reference: Technical descriptions of SerenityGPT's components, APIs, and configurations.

Versioning and document applicability

SerenityGPT follows a rolling release model, with releases identified by build hashes and date stamps. This documentation is continuously updated to reflect the latest features and changes in the product, though occasionally, updates may conflict with previously published information.

Highlighting changes

To help users stay informed about recent updates and ensure the documentation is backwards compatible:

• Changes affecting features or settings in recent releases are highlighted in the relevant sections of the documentation, as per the example below.
• These highlights remain visible for 6 months from the date of the change.

Example of a change highlight:

Navigation tips

Search

Use the search function at the top of the page to find specific topics. See Search mode in the Keyboard Navigation section below for more details.

General navigation

• The left sidebar provides an overview of the documentation structure.
• The right sidebar (on desktop) shows the current page's table of contents.
• Breadcrumbs at the top of each page help you understand your location within the documentation.

Keyboard navigation

Normal mode

This mode is active when search is not focussed:

• F or S or / opens search dialog.

• P or , goes to previous page.

• N or . goes to next page.

Search mode

This mode is active when the search is focused:

• P or , selects next / previous result.

• Esc or tab closes search dialog.

• Enter follows selected result.

Summary

We hope this documentation serves as a valuable resource in your journey with SerenityGPT. If you have any questions or feedback, please don't hesitate to reach out to our support team.