Fixing Vale errors, heading nesting

Author: RCheesley

docs/design/notifications.rst

@@ -1,13 +1,13 @@
 Notifications
-=============
+#############
 
 Notifications are a critical part of User experience (UX) in digital products, serving as a bridge between the system and the User. They should enhance, not detract from, the experience, assisting Users in achieving their goals and providing immediate, relevant feedback.
 
 Notification types and their use
-================================
+********************************
 
 Understanding notification variants
------------------------------------
+===================================
 
 Notifications come in various forms, each serving a specific purpose within an app:
 
@@ -18,39 +18,38 @@ Notifications come in various forms, each serving a specific purpose within an a
 - **Actionable notifications**: includes interactive elements and require User interaction. Styled similarly to inline or toast notifications, but more disruptive due to their interactive nature.
 
 Design
-------
+======
 
 - Carefully examine the context in which notifications appear. Use them sparingly and only when they add value to the User experience.
 - Maintain consistency in the design and behavior of notifications across the app.
 - Be sure to use high-contrast notifications for critical messaging, as low-contrast notifications are less visually disruptive.
 
 Content
--------
+=======
 
 - Notifications should be concise and to the point, with a short and descriptive title. Limit the body content to one or two sentences.
 
 Actions
--------
+=======
 
 - Limit actionable notifications to one action per notification to avoid overwhelming the User.
 - Inline notifications should persist until dismissed by the User or resolved through an action. Toast notifications can time out but should also include a close button.
 
 Accessibility
--------------
+=============
 
 - Notifications should be accessible and not rely solely on color to convey status, as this can be problematic for Users with color blindness, so use additional HTML attributes according to the notification type.
 - Toast notifications with interactive content shouldn't automatically disappear to remain Web Content Accessibility Guidelines 2.1 compliant.
 
 .. vale off
 
 Using notification Components
-=============================
+*****************************
 
 .. vale on
 
 Standard notifications with icons
----------------------------------
-
+=================================
 For standard notifications that include an icon, developers should use a ``<div>`` element with the class ``alert`` and an additional class to specify the type of notification:
 
 - ``.alert-success`` for success messages
@@ -71,7 +70,7 @@ Example:
 This displays a warning notification with an appropriate icon and color styling.
 
 Larger notification blocks without icons
-----------------------------------------
+========================================
 
 When you need a larger notification block - for instance to include headings or additional content - developers should use the ``alert`` class along with a column class that starts with the ``col-`` prefix. These notifications don't display an icon but have only a colored left border indicative of the notification type.
 
@@ -88,7 +87,7 @@ This creates a more substantial notification block with a heading and paragraph,
 
 
 Notifications for the notifications panel
-=========================================
+-----------------------------------------
 
 The ``NotificationModel`` class in ``NotificationModel.php`` manages notifications under the panel.
 
@@ -97,7 +96,7 @@ The ``NotificationModel`` class in ``NotificationModel.php`` manages notificatio
    The system defines the notification template in ``notification.html.twig``.
 
 Creating a notification
------------------------
+=======================
 
 To create a notification, use the ``addNotification`` method of the ``NotificationModel`` class. This method accepts several parameters to customize the notification:
 
@@ -120,15 +119,15 @@ To create a notification, use the ``addNotification`` method of the ``Notificati
    All notifications must have a header string defined.
 
 Parameters:
-^^^^^^^^^^^
+-----------
 
-.. vale of
+.. vale off
 
 - ``$message`` string: the main content of the notification.
-- ``$type`` string|null: identifies the source and style of the notification (optional).
-- ``$isRead`` (boolean): indicates if the system has marked the notification as read (default: true).
-- ``$header`` string|null: the header text for the notification (required).
-- ``$iconClass`` string|null: CSS class for the notification icon (for example, 'ri-eye-line').
+- ``$type`` string|null: identifies the source and style of the notification - optional.
+- ``$isRead`` boolean: indicates if the system has marked the notification as read - default: true.
+- ``$header`` string|null: the header text for the notification - required.
+- ``$iconClass`` string|null: CSS class for the notification icon - for example, 'ri-eye-line'.
 - ``$datetime`` \\DateTime|null: creation date of the notification.
 - ``$user`` User|null: the User object associated with the notification defaults to the current User.
 - ``$deduplicateValue`` string|null: used to prevent duplicate notifications within a specified timeframe.
@@ -138,11 +137,11 @@ Parameters:
 
 .. note::
 
-   The header should only contain the translation string; Twig handles the translation.
+   The header should only contain the translation string, as Twig handles the translation.
 
 
 Notification types
-------------------
+==================
 
 The ``$type`` parameter determines the visual style of the notification:
 .. vale off
@@ -156,7 +155,7 @@ The ``$type`` parameter determines the visual style of the notification:
 .. vale on
 
 Example usage
--------------
+=============
 
 Here's how to create a notification when you schedule a Contact export: