Skip to content

Commit 8681e37

Browse files
committed
Headings and vale fixes
1 parent 549e986 commit 8681e37

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/design/protip.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
ProTip template to enhancing user experience
2-
============================================
2+
############################################
33

44
The ProTip template is a powerful feature that displays helpful tips to Users, guiding them on how to use the platform like a pro. This template uses Twig. Here's how this template works and how to effectively use it in Mautic.
55

6-
Template structure and functionality
7-
------------------------------------
6+
Twig template for ProTips
7+
*************************
88

99
The ProTip template conditionally renders a tip when provided. Here's a breakdown of its key components:
1010

@@ -30,8 +30,8 @@ To include a ProTip in Mautic, use the following syntax:
3030
3131
{{ include('@MauticCore/Helper/protip.html.twig', {tip: 'mautic.core.protip.contacts.view'}) }}
3232
33-
In this example, it includes the ProTip template, and a translation key (``mautic.core.protip.contacts.view``) is passed as the tip content. This specific tip informs Users about using the ``V`` key to switch between card and table views.
33+
In this example, it includes the ProTip template and passes a translation key - ``mautic.core.protip.contacts.view`` - as the tip content. This specific tip informs Users about using the ``V`` key to switch between card and table views.
3434

35-
The use of a translation key instead of a hard-coded string allows for easy localization of tips. It also promotes consistency across Mautic, as the same tip can be reused in multiple places by referencing its key.
35+
The use of a translation key instead of a hard-coded string allows for easy localization of tips. It also promotes consistency across Mautic, as it's possible to reuse the same tip in multiple places by referencing its key.
3636

3737
Use the ProTip template to enhance the user experience of Mautic. These tips provide contextual help, highlighting shortcuts and features that Users might otherwise overlook. It's important to keep tips concise, relevant, and actionable to maximize their effectiveness in guiding Users to become 'Power Users'.

0 commit comments

Comments
 (0)