Notifications

Writing notifications in Sensedia Docs allows you to keep your team informed about important updates, changes, or alerts related to your documentation. This guide will help you understand how to create and manage notifications effectively.

Creating Notifications

Different from documentation, notifications are not written in markdown files. Instead, we use .yaml files to define notifications. These files are located in the notifications directory of your Sensedia Docs project.

Notification Structure

A notification YAML file typically includes the following fields:

• title: The title of the notification.
• message: The content of the notification.
• link: A URL link related to the notification.

As documentation, notification identifier is automatically generated based on the file name. For example, if you create a file named update-notification.yaml, the notification ID will be update-notification.

Example Notification

Here is an example of a notification defined in a YAML file:

Adding Notifications

To add a notification, create a new YAML file in the notifications directory with the desired notification details. Ensure the file name is descriptive, as it will be used as the notification identifier.

Managing Notifications

Notifications are self-managed by Sensedia Docs. Once you create a notification YAML file, it will automatically be processed and displayed in the notifications section of your documentation site. Notifications are also removed from the user interface when they expire or are no longer relevant, as determined by date and visualization rules.

Viewing Notifications

To view notifications, navigate to the notifications section of your Sensedia Docs site. Here, you will see a list of all active notifications, including their titles and messages. Clicking on a notification will set it as read, clicking on the link will take you to the relevant documentation.

Languages

Notifications can be localized by creating separate YAML files for each language you support. The file should be located in the correct language directory, example: notifications/en/update-notification.yaml for English. The structure remains the same, but the content will be translated to the respective language.

FAQ