Skip to main content

How to use this documentation

Updated today

Welcome to the Mistral AI Help Center documentation! πŸ‘‹

We’re excited to have you on board and help you make the most of Mistral AI’s products and services.

This article will guide you through the key features and conventions used in our documentation to ensure you can find the information you need quicky and efficiently.

About this documentation

We've designed this documentation to be user-friendly and comprehensive, catering to a wide range of users with varying levels of technical expertise.

Providing clear, concise, and product-first actionable articles, along with visual aids and practical examples, we aim to empower you to leverage Mistral AI's capabilities to their fullest potential.

Let's dive in!

How to find your way around

For the sake of clarity, we've structured this documentation into Articles (i.e. single pages about a specific topic) and Collections (a grouping of related Articles and/or other Collections).

πŸ“Œ For example, this page is an Article about How to use this documentation, and it is part of the Introduction Collection, which is itself part of the Getting Started Collection, as illustrated below:
​

Home Page
β”œβ”€β”€ Getting Started
β”‚   β”œβ”€β”€ Introduction
β”‚   β”‚   └── How to use this documentation
β”‚   └── Your first steps
β”œβ”€β”€ Le Chat
β”œβ”€β”€ La Plateforme
└── And so on...

As you may have already noticed, all root Collections can be accessed directly from the homepage of this documentation.

You can explore the documentation in two ways:

  • by browsing through Collections from the homepage

  • by using the help widget found at the very bottom right corner of every Help Center page

Starting from the homepage

Clicking anywhere on a Collection card from the homepage will take you to the related Collection page.

image

A Collection card you may encounter on the documentation homepage

From there, you will be presented with a list of Articles that may be grouped by topic for better readability.

You may return to the homepage at any time by clicking on the All Collections link in the breadcrumb located at the very top left corner of the page as illustrated below.

image

Click on the All Collections link to return to the homepage

Using the help widget

Additionaly, we provide you with a powerful widget that allows you to navigate through the Collections and search for Articles without leaving the page you're currently on.

To access it, click on the round button with the Mistral icon then navigage to the Help tab as show in the screenshots below.

image

Locate and click on the Mistral icon button to open the help widget

image

Click on the Help tab to navigate through the Collections

Another way to find your way around the documentation is to use the Search bar, which you may found in the top of the page header of any Article or Collection, as shown below:

image

Locate and click on the Search bar

πŸ’‘ You don't need to type the full title of the Article you're looking for, the search will return relevant results based on the keywords you enter. For example, typing create API key will return the How do I create API keys within a Workspace? Article, along with other relevant results.

A note on the Tags

You may have noticed that some Articles are tagged with specific labels (e.g. Beta, Le Chat Enterprise, etc.), typically found at the top of the page.

These tags are intended to let you quickly identify the scope and relevance of the Article to your specific use case.

All Tags along with their definitions can be found in the General Definitions section of this documentation.

What's next?

Feeling confident? You may now directly jump in to any Collection of your choice.

πŸ”Ž If you need more guidance, we invite you to first discover the next Collection, called Your first steps, which will guide you through the basic steps to kickstart your Mistral AI journey.

Did this answer your question?